diff --git a/AASX-File-Server/openapi.yaml b/AASX-File-Server/openapi.yaml deleted file mode 100644 index 83197bc4..00000000 --- a/AASX-File-Server/openapi.yaml +++ /dev/null @@ -1,243 +0,0 @@ -openapi: 3.0.3 -info: - title: DotAAS Part 2 | HTTP/REST | AASX File Server API - description: The AASX file server API as part of Details of the Asset Administration Shell Part 2 - contact: - name: Constantin Ziesche, Andreas Orzelski, Florian Krebs, Bastian Rössl, Manuel Sauer, Jens Vialkowitsch, Michael Hoffmeister, Torben Miny, Sebastian Bader, Marko Ristin, Nico Braunisch - version: V1.0RC03 - termsOfService: https://github.com/admin-shell-io/aas-specs -servers: -- url: '{protocol}://{host_name}:{port}/api/{version_prefix}' - variables: - protocol: - description: 'Allows access through http and https (recommended)' - enum: - - 'http' - - 'https' - default: 'https' - host_name: - default: admin-shell.io - description: 'Hostname of server hosting the api' - port: - enum: - - '80' - - '443' - default: '443' - description: '80 is default for http, 443 for https' - version_prefix: - enum: - - 'v1' - default: v1 -paths: - /packages: - get: - tags: - - AASX File Server API - summary: Returns a list of available AASX packages at the server - operationId: GetAllAASXPackageIds - x-semanticIds: - - https://admin-shell.io/aas/API/GetAllAASXPackageIds/1/0/RC03 - parameters: - - name: aasId - in: query - description: The Asset Administration Shell’s unique id (UTF8-BASE64-URL-encoded) - required: false - style: form - explode: true - schema: - type: string - format: byte - responses: - '200': - description: Requested package list - content: - application/json: - schema: - type: array - items: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V1.0RC03#/components/schemas/PackageDescription' - default: - description: Default error handling for unmentioned status codes - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V1.0RC03#/components/schemas/Result' - post: - tags: - - AASX File Server API - summary: Stores the AASX package at the server - operationId: PostAASXPackage - x-semanticIds: - - https://admin-shell.io/aas/API/PostAASXPackage/1/0/RC03 - requestBody: - description: AASX package - content: - multipart/form-data: - schema: - type: object - properties: - aasIds: - type: array - items: - type: string - file: - type: string - format: binary - fileName: - type: string - encoding: - file: - contentType: application/asset-administration-shell-package - required: true - responses: - '201': - description: AASX package stored successfully - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V1.0RC03#/components/schemas/PackageDescription' - '400': - description: Bad Request - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V1.0RC03#/components/schemas/Result' - default: - description: Default error handling for unmentioned status codes - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V1.0RC03#/components/schemas/Result' - /packages/{packageId}: - get: - tags: - - AASX File Server API - summary: Returns a specific AASX package from the server - operationId: GetAASXByPackageId - x-semanticIds: - - https://admin-shell.io/aas/API/GetAASXByPackageId/1/0/RC03 - parameters: - - name: packageId - in: path - description: The package Id (UTF8-BASE64-URL-encoded) - required: true - style: simple - explode: true - schema: - type: string - format: byte - responses: - '200': - description: Requested AASX package - headers: - X-FileName: - schema: - type: string - description: Filename of the package - content: - application/asset-administration-shell-package: - schema: - type: string - format: binary - '404': - description: Not Found - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V1.0RC03#/components/schemas/Result' - default: - description: Default error handling for unmentioned status codes - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V1.0RC03#/components/schemas/Result' - put: - tags: - - AASX File Server API - summary: Updates the AASX package at the server - operationId: PutAASXByPackageId - x-semanticIds: - - https://admin-shell.io/aas/API/PutAASXByPackageId/1/0/RC03 - parameters: - - name: packageId - in: path - description: The Package Id (UTF8-BASE64-URL-encoded) - required: true - style: simple - explode: true - schema: - type: string - format: byte - requestBody: - description: AASX package - content: - multipart/form-data: - schema: - type: object - properties: - aasIds: - type: array - items: - type: string - file: - type: string - format: binary - fileName: - type: string - encoding: - file: - contentType: application/asset-administration-shell-package - required: true - responses: - '204': - description: AASX package updated successfully - '400': - description: Bad Request - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V1.0RC03#/components/schemas/Result' - '404': - description: Not Found - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V1.0RC03#/components/schemas/Result' - default: - description: Default error handling for unmentioned status codes - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V1.0RC03#/components/schemas/Result' - delete: - tags: - - AASX File Server API - summary: Deletes a specific AASX package from the server - operationId: DeleteAASXByPackageId - x-semanticIds: - - https://admin-shell.io/aas/API/DeleteAASXByPackageId/1/0/RC03 - parameters: - - name: packageId - in: path - description: The Package Id (UTF8-BASE64-URL-encoded) - required: true - style: simple - explode: true - schema: - type: string - format: byte - responses: - '204': - description: Deleted successfully - '404': - description: Not Found - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V1.0RC03#/components/schemas/Result' - default: - description: Default error handling for unmentioned status codes - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V1.0RC03#/components/schemas/Result' \ No newline at end of file diff --git a/AasxFileServerServiceSpecification/V3.0.yaml b/AasxFileServerServiceSpecification/V3.0.yaml deleted file mode 100644 index 51b61457..00000000 --- a/AasxFileServerServiceSpecification/V3.0.yaml +++ /dev/null @@ -1,240 +0,0 @@ -openapi: 3.0.3 -info: - title: DotAAS Part 2 | HTTP/REST | AASX File Server Service Specification - description: "The File Server Service Specification as part of Details of the Asset Administration Shell Part 2 - Copyright: Industrial Digital Twin Association (IDTA) 2023" - contact: - name: Industrial Digital Twin Association (IDTA) - email: info@idtwin.org - license: - name: CC BY-SA 4.0 - url: https://creativecommons.org/licenses/by-sa/4.0/ - version: V3.0 - termsOfService: https://github.com/admin-shell-io/aas-specs -servers: -- url: '{protocol}://{host_name}:{port}/api/{version_prefix}' - variables: - protocol: - description: 'Allows access through http and https (recommended)' - enum: - - 'http' - - 'https' - default: 'https' - host_name: - default: admin-shell.io - description: 'Hostname of server hosting the api' - port: - enum: - - '80' - - '443' - default: '443' - description: '80 is default for http, 443 for https' - version_prefix: - enum: - - 'v3.0' - default: v3.0 -paths: - /packages: - get: - tags: - - AASX File Server API - summary: Returns a list of available AASX packages at the server - operationId: GetAllAASXPackageIds - x-semanticIds: - - https://admin-shell.io/aas/API/GetAllAASXPackageIds/3/0 - parameters: - - name: aasId - in: query - description: The Asset Administration Shell’s unique id (UTF8-BASE64-URL-encoded) - required: false - style: form - explode: true - schema: - type: string - format: byte - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Limit' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Cursor' - responses: - '200': - description: Requested package list - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/GetPackageDescriptionsResult' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - post: - tags: - - AASX File Server API - summary: Stores the AASX package at the server - operationId: PostAASXPackage - x-semanticIds: - - https://admin-shell.io/aas/API/PostAASXPackage/3/0 - requestBody: - description: AASX package - content: - multipart/form-data: - schema: - type: object - properties: - aasIds: - type: array - items: - type: string - file: - type: string - format: binary - fileName: - type: string - encoding: - file: - contentType: application/asset-administration-shell-package - required: true - responses: - '201': - description: AASX package stored successfully - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/PackageDescription' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '409': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/conflict' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /packages/{packageId}: - parameters: - - name: packageId - in: path - description: The package Id (UTF8-BASE64-URL-encoded) - required: true - style: simple - explode: true - schema: - type: string - format: byte - get: - tags: - - AASX File Server API - summary: Returns a specific AASX package from the server - operationId: GetAASXByPackageId - x-semanticIds: - - https://admin-shell.io/aas/API/GetAASXByPackageId/3/0 - responses: - '200': - description: Requested AASX package - headers: - X-FileName: - schema: - type: string - description: Filename of the package - content: - application/asset-administration-shell-package: - schema: - type: string - format: binary - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - put: - tags: - - AASX File Server API - summary: Updates the AASX package at the server - operationId: PutAASXByPackageId - x-semanticIds: - - https://admin-shell.io/aas/API/PutAASXByPackageId/3/0 - requestBody: - description: AASX package - content: - multipart/form-data: - schema: - type: object - properties: - aasIds: - type: array - items: - type: string - file: - type: string - format: binary - fileName: - type: string - encoding: - file: - contentType: application/asset-administration-shell-package - required: true - responses: - '204': - description: AASX package updated successfully - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - delete: - tags: - - AASX File Server API - summary: Deletes a specific AASX package from the server - operationId: DeleteAASXByPackageId - x-semanticIds: - - https://admin-shell.io/aas/API/DeleteAASXByPackageId/3/0 - responses: - '204': - description: Deleted successfully - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /description: - get: - tags: - - Description API - summary: Returns the self-describing information of a network resource (ServiceDescription) - operationId: GetDescription - x-semanticIds: - - https://admin-shell.io/aas/API/Descriptor/GetDescription/3/0 - responses: - '200': - description: Requested Description - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/ServiceDescription' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' \ No newline at end of file diff --git a/AssetAdministrationShell-API/openapi.yaml b/AssetAdministrationShell-API/openapi.yaml deleted file mode 100644 index 7f8f4dd6..00000000 --- a/AssetAdministrationShell-API/openapi.yaml +++ /dev/null @@ -1,1680 +0,0 @@ -openapi: 3.0.3 -info: - title: DotAAS Part 2 | HTTP/REST | Asset Adminstration Shell API - description: An exemplary API combination for the use case of a standalone Asset Administration Shell, e.g., an Asset Administration Shell running in a Docker container - contact: - name: Constantin Ziesche, Andreas Orzelski, Florian Krebs, Bastian Rössl, Manuel Sauer, Jens Vialkowitsch, Michael Hoffmeister, Torben Miny, Sebastian Bader, Marko Ristin, Nico Braunisch - version: V3.0 - termsOfService: https://github.com/admin-shell-io/aas-specs -servers: -- url: '{protocol}://{host_name}:{port}/api/{version_prefix}' - variables: - protocol: - description: 'Allows access through http and https (recommended)' - enum: - - 'http' - - 'https' - default: 'https' - host_name: - default: admin-shell.io - description: 'Hostname of server hosting the api' - port: - enum: - - '80' - - '443' - default: '443' - description: '80 is default for http, 443 for https' - version_prefix: - enum: - - 'v1' - default: v1 -paths: - /aas: - get: - tags: - - Asset Administration Shell API - summary: Returns a specific Asset Administration Shell - operationId: GetAssetAdministrationShell - x-semanticIds: - - https://admin-shell.io/aas/API/GetAssetAdministrationShell/3/0 - responses: - '200': - description: Requested Asset Administration Shell - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0#/components/schemas/AssetAdministrationShell' - '400': - $ref: '#/components/responses/bad-request' - '403': - $ref: '#/components/responses/forbidden' - '404': - $ref: '#/components/responses/not-found' - '405': - $ref: '#/components/responses/method-not-allowed' - '500': - $ref: '#/components/responses/internal-server-error' - '501': - $ref: '#/components/responses/not-implemented' - default: - $ref: '#/components/responses/default' - put: - tags: - - Asset Administration Shell API - summary: Updates an existing Asset Administration Shell - operationId: PutAssetAdministrationShell - x-semanticIds: - - https://admin-shell.io/aas/API/PutAssetAdministrationShell/3/0 - requestBody: - description: Asset Administration Shell object - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0#/components/schemas/AssetAdministrationShell' - required: true - responses: - '204': - description: Asset Administration Shell updated successfully - '400': - $ref: '#/components/responses/bad-request' - '403': - $ref: '#/components/responses/forbidden' - '404': - $ref: '#/components/responses/not-found' - '405': - $ref: '#/components/responses/method-not-allowed' - '500': - $ref: '#/components/responses/internal-server-error' - '501': - $ref: '#/components/responses/not-implemented' - default: - $ref: '#/components/responses/default' - delete: - tags: - - Asset Administration Shell API - summary: Deletes an Asset Administration Shell - operationId: DeleteAssetAdministrationShell - x-semanticIds: - - https://admin-shell.io/aas/API/DeleteAssetAdministrationShell/3/0 - responses: - '204': - description: Asset Administration Shell deleted successfully - '404': - description: Not Found - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/Result' - default: - description: Default error handling for unmentioned status codes - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/Result' - /aas/$reference: - get: - tags: - - Asset Administration Shell API - summary: Returns a specific Asset Administration Shell as a Reference - operationId: GetAssetAdministrationShellReference - x-semanticIds: - - https://admin-shell.io/aas/API/GetAssetAdministrationShel/3/0 - responses: - '200': - description: Requested Asset Administration Shell - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0#/components/schemas/Reference' - '400': - $ref: '#/components/responses/bad-request' - '403': - $ref: '#/components/responses/forbidden' - '404': - $ref: '#/components/responses/not-found' - '405': - $ref: '#/components/responses/method-not-allowed' - '500': - $ref: '#/components/responses/internal-server-error' - '501': - $ref: '#/components/responses/not-implemented' - default: - $ref: '#/components/responses/default' - /aas/asset-information: - get: - tags: - - Asset Administration Shell API - summary: Returns the Asset Information - operationId: GetAssetInformation - x-semanticIds: - - https://admin-shell.io/aas/API/GetAssetInformation/3/0 - responses: - '200': - description: Requested Asset Information - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0#/components/schemas/AssetInformation' - '400': - $ref: '#/components/responses/bad-request' - '403': - $ref: '#/components/responses/forbidden' - '404': - $ref: '#/components/responses/not-found' - '405': - $ref: '#/components/responses/method-not-allowed' - '500': - $ref: '#/components/responses/internal-server-error' - '501': - $ref: '#/components/responses/not-implemented' - default: - $ref: '#/components/responses/default' - put: - tags: - - Asset Administration Shell API - summary: Updates the Asset Information - operationId: PutAssetInformation - x-semanticIds: - - https://admin-shell.io/aas/API/PutAssetInformation/3/0 - requestBody: - description: Asset Information object - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0#/components/schemas/AssetInformation' - required: true - responses: - '204': - description: Asset Information updated successfully - '400': - $ref: '#/components/responses/bad-request' - '403': - $ref: '#/components/responses/forbidden' - '404': - $ref: '#/components/responses/not-found' - '405': - $ref: '#/components/responses/method-not-allowed' - '500': - $ref: '#/components/responses/internal-server-error' - '501': - $ref: '#/components/responses/not-implemented' - default: - $ref: '#/components/responses/default' - /aas/submodels: - get: - tags: - - Asset Administration Shell API - summary: Returns all submodel references - operationId: GetAllSubmodelReferences - x-semanticIds: - - https://admin-shell.io/aas/API/GetAllSubmodelReferences/3/0 - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/From' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Size' - responses: - '200': - description: Requested submodel references - content: - application/json: - schema: - type: array - items: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0#/components/schemas/Reference' - '400': - $ref: '#/components/responses/bad-request' - '403': - $ref: '#/components/responses/forbidden' - '404': - $ref: '#/components/responses/not-found' - '405': - $ref: '#/components/responses/method-not-allowed' - '500': - $ref: '#/components/responses/internal-server-error' - '501': - $ref: '#/components/responses/not-implemented' - default: - $ref: '#/components/responses/default' - post: - tags: - - Asset Administration Shell API - summary: Creates a submodel reference at the Asset Administration Shell - operationId: PostSubmodelReference - x-semanticIds: - - https://admin-shell.io/aas/API/PostSubmodelReference/3/0 - requestBody: - description: Reference to the Submodel - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0#/components/schemas/Reference' - required: true - responses: - '201': - description: Submodel reference created successfully - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0#/components/schemas/Reference' - '400': - $ref: '#/components/responses/bad-request' - '403': - $ref: '#/components/responses/forbidden' - '404': - $ref: '#/components/responses/not-found' - '405': - $ref: '#/components/responses/method-not-allowed' - '500': - $ref: '#/components/responses/internal-server-error' - '501': - $ref: '#/components/responses/not-implemented' - default: - $ref: '#/components/responses/default' - /aas/submodels/{submodelIdentifier}: - delete: - tags: - - Asset Administration Shell API - summary: Deletes the submodel reference from the Asset Administration Shell. Does not delete the submodel itself! - operationId: DeleteSubmodelReferenceById - x-semanticIds: - - https://admin-shell.io/aas/API/DeleteSubmodelReference/3/0 - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/SubmodelIdentifier' - responses: - '204': - description: Submodel reference deleted successfully - '400': - $ref: '#/components/responses/bad-request' - '403': - $ref: '#/components/responses/forbidden' - '404': - $ref: '#/components/responses/not-found' - '405': - $ref: '#/components/responses/method-not-allowed' - '500': - $ref: '#/components/responses/internal-server-error' - '501': - $ref: '#/components/responses/not-implemented' - default: - $ref: '#/components/responses/default' - get: - tags: - - Asset Administration Shell API - summary: Returns the Submodel - operationId: GetSubmodel - x-semanticIds: - - https://admin-shell.io/aas/API/GetSubmodel/3/0 - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/SubmodelIdentifier' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Level' - responses: - '200': - description: Requested Submodel - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0#/components/schemas/Submodel' - '400': - $ref: '#/components/responses/bad-request' - '403': - $ref: '#/components/responses/forbidden' - '404': - $ref: '#/components/responses/not-found' - '405': - $ref: '#/components/responses/method-not-allowed' - '500': - $ref: '#/components/responses/internal-server-error' - '501': - $ref: '#/components/responses/not-implemented' - default: - $ref: '#/components/responses/default' - put: - tags: - - Asset Administration Shell API - summary: Updates the Submodel - operationId: PutSubmodel - x-semanticIds: - - https://admin-shell.io/aas/API/PutSubmodel/3/0 - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/SubmodelIdentifier' - #- $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Level' - - name: level - in: query - description: Determines the structural depth of the respective resource content - required: false - schema: - type: string - default: deep - enum: - - deep # only 'deep' is allowed for PUT - #- core - requestBody: - description: Submodel object - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0#/components/schemas/Submodel' - required: true - responses: - '204': - description: Submodel updated successfully - '400': - $ref: '#/components/responses/bad-request' - '403': - $ref: '#/components/responses/forbidden' - '404': - $ref: '#/components/responses/not-found' - '405': - $ref: '#/components/responses/method-not-allowed' - '500': - $ref: '#/components/responses/internal-server-error' - '501': - $ref: '#/components/responses/not-implemented' - default: - $ref: '#/components/responses/default' - patch: - tags: - - Asset Administration Shell API - summary: Updates the Submodel - operationId: PatchSubmodel - x-semanticIds: - - https://admin-shell.io/aas/API/PutSubmodel/3/0 - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/SubmodelIdentifier' - #- $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Level' - - name: level - in: query - description: Determines the structural depth of the respective resource content - required: false - schema: - type: string - default: core - enum: - #- deep - - core # only 'deep' is allowed for PUT - requestBody: - description: Submodel object - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0#/components/schemas/Submodel' - required: true - responses: - '204': - description: Submodel updated successfully - '400': - $ref: '#/components/responses/bad-request' - '403': - $ref: '#/components/responses/forbidden' - '404': - $ref: '#/components/responses/not-found' - '405': - $ref: '#/components/responses/method-not-allowed' - '500': - $ref: '#/components/responses/internal-server-error' - '501': - $ref: '#/components/responses/not-implemented' - default: - $ref: '#/components/responses/default' - /aas/submodels/{submodelIdentifier}/$metadata: - get: - tags: - - Asset Administration Shell API - summary: Returns the Submodel's metadata elements - operationId: GetSubmodelMetadata - x-semanticIds: - - https://admin-shell.io/aas/API/GetSubmodel/3/0 - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/SubmodelIdentifier' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Level' - responses: - '200': - description: Requested Submodel - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/SubmodelMetadata' - '400': - $ref: '#/components/responses/bad-request' - '403': - $ref: '#/components/responses/forbidden' - '404': - $ref: '#/components/responses/not-found' - '405': - $ref: '#/components/responses/method-not-allowed' - '500': - $ref: '#/components/responses/internal-server-error' - '501': - $ref: '#/components/responses/not-implemented' - default: - $ref: '#/components/responses/default' - patch: - tags: - - Asset Administration Shell API - summary: Updates the metadata attributes of the Submodel - operationId: PatchSubmodelMetadata - x-semanticIds: - - https://admin-shell.io/aas/API/PutSubmodel/3/0 - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/SubmodelIdentifier' - #- $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Level' - - name: level - in: query - description: Determines the structural depth of the respective resource content - required: false - schema: - type: string - default: core - enum: - #- deep - - core # only 'deep' is allowed for PUT - requestBody: - description: Submodel object - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/SubmodelMetadata' - required: true - responses: - '204': - description: Submodel updated successfully - '400': - $ref: '#/components/responses/bad-request' - '403': - $ref: '#/components/responses/forbidden' - '404': - $ref: '#/components/responses/not-found' - '405': - $ref: '#/components/responses/method-not-allowed' - '500': - $ref: '#/components/responses/internal-server-error' - '501': - $ref: '#/components/responses/not-implemented' - default: - $ref: '#/components/responses/default' - /aas/submodels/{submodelIdentifier}/$value: - get: - tags: - - Asset Administration Shell API - summary: Returns the Submodel's ValueOnly representation - operationId: GetSubmodelValueOnly - x-semanticIds: - - https://admin-shell.io/aas/API/GetSubmodel/3/0 - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/SubmodelIdentifier' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Level' - responses: - '200': - description: Requested Submodel - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/SubmodelValue' - '400': - $ref: '#/components/responses/bad-request' - '403': - $ref: '#/components/responses/forbidden' - '404': - $ref: '#/components/responses/not-found' - '405': - $ref: '#/components/responses/method-not-allowed' - '500': - $ref: '#/components/responses/internal-server-error' - '501': - $ref: '#/components/responses/not-implemented' - default: - $ref: '#/components/responses/default' - patch: - tags: - - Asset Administration Shell API - summary: Updates teh values of the Submodel - operationId: PatchSubmodelValueOnly - x-semanticIds: - - https://admin-shell.io/aas/API/PutSubmodel/3/0 - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/SubmodelIdentifier' - #- $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Level' - - name: level - in: query - description: Determines the structural depth of the respective resource content - required: false - schema: - type: string - default: core - enum: - #- deep - - core # only 'deep' is allowed for PUT - requestBody: - description: Submodel object in the ValueOnly representation - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/SubmodelValue' - required: true - responses: - '204': - description: Submodel updated successfully - '400': - $ref: '#/components/responses/bad-request' - '403': - $ref: '#/components/responses/forbidden' - '404': - $ref: '#/components/responses/not-found' - '405': - $ref: '#/components/responses/method-not-allowed' - '500': - $ref: '#/components/responses/internal-server-error' - '501': - $ref: '#/components/responses/not-implemented' - default: - $ref: '#/components/responses/default' - /submodels/{submodelIdentifier}/$reference: - get: - tags: - - Asset Administration Shell API - summary: Returns the Submodel as a Reference - operationId: GetSubmodelMetadataReference - x-semanticIds: - - https://admin-shell.io/aas/API/GetSubmodel/3/0 - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/SubmodelIdentifier' - #- $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Level' - - name: level - in: query - description: Determines the structural depth of the respective resource content - required: false - schema: - type: string - default: core - enum: - # - deep - - core # only 'core' is allowed for Content=Reference - responses: - '200': - description: Requested Submodel as a Reference - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0#/components/schemas/Reference' - '400': - $ref: '#/components/responses/bad-request' - '403': - $ref: '#/components/responses/forbidden' - '404': - $ref: '#/components/responses/not-found' - '405': - $ref: '#/components/responses/method-not-allowed' - '500': - $ref: '#/components/responses/internal-server-error' - '501': - $ref: '#/components/responses/not-implemented' - default: - $ref: '#/components/responses/default' - - /aas/submodels/{submodelIdentifier}/$path: - get: - tags: - - Asset Administration Shell API - summary: Returns the Submodel's metadata elements - operationId: GetSubmodelPath - x-semanticIds: - - https://admin-shell.io/aas/API/GetSubmodel/3/0 - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/SubmodelIdentifier' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Level' - responses: - '200': - description: Requested Submodel in Path notation - content: - application/json: - schema: - type: array - items: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/PathItem' - '400': - $ref: '#/components/responses/bad-request' - '403': - $ref: '#/components/responses/forbidden' - '404': - $ref: '#/components/responses/not-found' - '405': - $ref: '#/components/responses/method-not-allowed' - '500': - $ref: '#/components/responses/internal-server-error' - '501': - $ref: '#/components/responses/not-implemented' - default: - $ref: '#/components/responses/default' - /aas/submodels/{submodelIdentifier}/submodel-elements: - get: - tags: - - Asset Administration Shell API - summary: Returns all submodel elements including their hierarchy - operationId: GetAllSubmodelElements - x-semanticIds: - - https://admin-shell.io/aas/API/GetAllSubmodelElements/3/0 - - https://admin-shell.io/aas/API/GetAllSubmodelElementsBySemanticId/3/0 - - https://admin-shell.io/aas/API/GetAllSubmodelElementsByParentPathAndSemanticId/3/0 - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/SubmodelIdentifier' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/From' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Size' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Level' - responses: - '200': - description: List of found submodel elements - content: - application/json: - schema: - type: array - items: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0#/components/schemas/SubmodelElement' - '400': - $ref: '#/components/responses/bad-request' - '403': - $ref: '#/components/responses/forbidden' - '404': - $ref: '#/components/responses/not-found' - '405': - $ref: '#/components/responses/method-not-allowed' - '500': - $ref: '#/components/responses/internal-server-error' - '501': - $ref: '#/components/responses/not-implemented' - default: - $ref: '#/components/responses/default' - post: - tags: - - Asset Administration Shell API - summary: Creates a new submodel element - operationId: PostSubmodelElement - x-semanticIds: - - https://admin-shell.io/aas/API/PostSubmodelElement/3/0 - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Level' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Content' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Extent' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/SubmodelIdentifier' - requestBody: - description: Requested submodel element - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0#/components/schemas/SubmodelElement' - required: true - responses: - '201': - description: Submodel element created successfully - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0#/components/schemas/SubmodelElement' - '400': - $ref: '#/components/responses/bad-request' - '403': - $ref: '#/components/responses/forbidden' - '404': - $ref: '#/components/responses/not-found' - '405': - $ref: '#/components/responses/method-not-allowed' - '500': - $ref: '#/components/responses/internal-server-error' - '501': - $ref: '#/components/responses/not-implemented' - default: - $ref: '#/components/responses/default' - /aas/submodels/{submodelIdentifier}/submodel-elements/$metadata: - get: - tags: - - Asset Administration Shell API - summary: Returns all submodel elements including their hierarchy - operationId: GetAllSubmodelElementsMetadata - x-semanticIds: - - https://admin-shell.io/aas/API/GetAllSubmodelElements/3/0 - - https://admin-shell.io/aas/API/GetAllSubmodelElementsBySemanticId/3/0 - - https://admin-shell.io/aas/API/GetAllSubmodelElementsByParentPathAndSemanticId/3/0 - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/SubmodelIdentifier' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/From' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Size' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Level' - responses: - '200': - description: List of found submodel elements - content: - application/json: - schema: - type: array - items: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/SubmodelElementMetadata' - '400': - $ref: '#/components/responses/bad-request' - '403': - $ref: '#/components/responses/forbidden' - '404': - $ref: '#/components/responses/not-found' - '405': - $ref: '#/components/responses/method-not-allowed' - '500': - $ref: '#/components/responses/internal-server-error' - '501': - $ref: '#/components/responses/not-implemented' - default: - $ref: '#/components/responses/default' - /aas/submodels/{submodelIdentifier}/submodel-elements/$value: - get: - tags: - - Asset Administration Shell API - summary: Returns all submodel elements including their hierarchy in the ValueOnly representation - operationId: GetAllSubmodelElementsValueOnly - x-semanticIds: - - https://admin-shell.io/aas/API/GetAllSubmodelElements/3/0 - - https://admin-shell.io/aas/API/GetAllSubmodelElementsBySemanticId/3/0 - - https://admin-shell.io/aas/API/GetAllSubmodelElementsByParentPathAndSemanticId/3/0 - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/SubmodelIdentifier' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/From' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Size' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Level' - responses: - '200': - description: List of found submodel elements in their ValueOnly representation - content: - application/json: - schema: - type: array - items: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/SubmodelElementValue' - '400': - $ref: '#/components/responses/bad-request' - '403': - $ref: '#/components/responses/forbidden' - '404': - $ref: '#/components/responses/not-found' - '405': - $ref: '#/components/responses/method-not-allowed' - '500': - $ref: '#/components/responses/internal-server-error' - '501': - $ref: '#/components/responses/not-implemented' - default: - $ref: '#/components/responses/default' - /aas/submodels/{submodelIdentifier}/submodel-elements/$reference: - get: - tags: - - Asset Administration Shell API - summary: Returns all submodel elements as a list of References - operationId: GetAllSubmodelElementsReference - x-semanticIds: - - https://admin-shell.io/aas/API/GetAllSubmodelElements/3/0 - - https://admin-shell.io/aas/API/GetAllSubmodelElementsBySemanticId/3/0 - - https://admin-shell.io/aas/API/GetAllSubmodelElementsByParentPathAndSemanticId/3/0 - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/SubmodelIdentifier' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/From' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Size' - #- $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Level' - - name: level - in: query - description: Determines the structural depth of the respective resource content - required: false - schema: - type: string - default: core - enum: - # - deep - - core # only 'core' is allowed for Content=Reference - responses: - '200': - description: List of References of the found submodel elements - content: - application/json: - schema: - type: array - items: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0#/components/schemas/Reference' - '400': - $ref: '#/components/responses/bad-request' - '403': - $ref: '#/components/responses/forbidden' - '404': - $ref: '#/components/responses/not-found' - '405': - $ref: '#/components/responses/method-not-allowed' - '500': - $ref: '#/components/responses/internal-server-error' - '501': - $ref: '#/components/responses/not-implemented' - default: - $ref: '#/components/responses/default' - /aas/submodels/{submodelIdentifier}/submodel-elements/$path: - get: - tags: - - Asset Administration Shell API - summary: Returns all submodel elements including their hierarchy - operationId: GetAllSubmodelElementsPath - x-semanticIds: - - https://admin-shell.io/aas/API/GetAllSubmodelElements/3/0 - - https://admin-shell.io/aas/API/GetAllSubmodelElementsBySemanticId/3/0 - - https://admin-shell.io/aas/API/GetAllSubmodelElementsByParentPathAndSemanticId/3/0 - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/SubmodelIdentifier' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/From' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Size' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Level' - responses: - '200': - description: List of found submodel elements in the Path notation - content: - application/json: - schema: - type: array - items: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/PathItem' - '400': - $ref: '#/components/responses/bad-request' - '403': - $ref: '#/components/responses/forbidden' - '404': - $ref: '#/components/responses/not-found' - '405': - $ref: '#/components/responses/method-not-allowed' - '500': - $ref: '#/components/responses/internal-server-error' - '501': - $ref: '#/components/responses/not-implemented' - default: - $ref: '#/components/responses/default' - /aas/submodels/{submodelIdentifier}/submodel-elements/{idShortPath}: - get: - tags: - - Asset Administration Shell API - summary: Returns a specific submodel element from the Submodel at a specified - path - operationId: GetSubmodelElementByPath - x-semanticIds: - - https://admin-shell.io/aas/API/GetSubmodelElementByPath/3/0 - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/SubmodelIdentifier' - - name: idShortPath - in: path - description: IdShort path to the submodel element (dot-separated) - required: true - style: simple - explode: false - schema: - type: string - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/From' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Size' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Level' - responses: - '200': - description: Requested submodel element - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0#/components/schemas/SubmodelElement' - '400': - $ref: '#/components/responses/bad-request' - '403': - $ref: '#/components/responses/forbidden' - '404': - $ref: '#/components/responses/not-found' - '405': - $ref: '#/components/responses/method-not-allowed' - '500': - $ref: '#/components/responses/internal-server-error' - '501': - $ref: '#/components/responses/not-implemented' - default: - $ref: '#/components/responses/default' - post: - tags: - - Asset Administration Shell API - summary: Creates a new submodel element at a specified path within submodel elements hierarchy - operationId: PostSubmodelElementByPath - x-semanticIds: - - https://admin-shell.io/aas/API/PostSubmodelElementByPath/3/0 - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/SubmodelIdentifier' - - name: idShortPath - in: path - description: IdShort path to the submodel element (dot-separated) - required: true - style: simple - explode: false - schema: - type: string - requestBody: - description: Requested submodel element - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0#/components/schemas/SubmodelElement' - required: true - responses: - '201': - description: Submodel element created successfully - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0#/components/schemas/SubmodelElement' - '400': - $ref: '#/components/responses/bad-request' - '403': - $ref: '#/components/responses/forbidden' - '404': - $ref: '#/components/responses/not-found' - '405': - $ref: '#/components/responses/method-not-allowed' - '500': - $ref: '#/components/responses/internal-server-error' - '501': - $ref: '#/components/responses/not-implemented' - default: - $ref: '#/components/responses/default' - put: - tags: - - Asset Administration Shell API - summary: Updates an existing submodel element at a specified path within submodel elements hierarchy - operationId: PutSubmodelElementByPath - x-semanticIds: - - https://admin-shell.io/aas/API/PutSubmodelElementByPath/3/0 - - https://admin-shell.io/aas/API/SetSubmodelElementValueByPath/3/0 - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/SubmodelIdentifier' - - name: idShortPath - in: path - description: IdShort path to the submodel element (dot-separated) - required: true - style: simple - explode: false - schema: - type: string - requestBody: - description: Requested submodel element - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0#/components/schemas/SubmodelElement' - required: true - responses: - '204': - description: Submodel element updated successfully - '400': - $ref: '#/components/responses/bad-request' - '403': - $ref: '#/components/responses/forbidden' - '404': - $ref: '#/components/responses/not-found' - '405': - $ref: '#/components/responses/method-not-allowed' - '500': - $ref: '#/components/responses/internal-server-error' - '501': - $ref: '#/components/responses/not-implemented' - default: - $ref: '#/components/responses/default' - patch: - tags: - - Asset Administration Shell API - summary: Updates an existing submodel element value at a specified path within submodel elements hierarchy - operationId: PatchSubmodelElementValueByPath - x-semanticIds: - - https://admin-shell.io/aas/API/PatchSubmodelElementByPath/3/0 - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/SubmodelIdentifier' - - name: idShortPath - in: path - description: IdShort path to the submodel element (dot-separated) - required: true - style: simple - explode: false - schema: - type: string - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Level' - requestBody: - description: The updated value of the submodel element - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/SubmodelElement' - required: true - responses: - '204': - description: Submodel element updated successfully - '400': - $ref: '#/components/responses/bad-request' - '403': - $ref: '#/components/responses/forbidden' - '404': - $ref: '#/components/responses/not-found' - '405': - $ref: '#/components/responses/method-not-allowed' - '500': - $ref: '#/components/responses/internal-server-error' - '501': - $ref: '#/components/responses/not-implemented' - default: - $ref: '#/components/responses/default' - delete: - tags: - - Asset Administration Shell API - summary: Deletes a submodel element at a specified path within the submodel elements hierarchy - operationId: DeleteSubmodelElementByPath - x-semanticIds: - - https://admin-shell.io/aas/API/DeleteSubmodelElementByPath/3/0 - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/SubmodelIdentifier' - - name: idShortPath - in: path - description: IdShort path to the submodel element (dot-separated) - required: true - style: simple - explode: false - schema: - type: string - responses: - '204': - description: Submodel element deleted successfully - '400': - $ref: '#/components/responses/bad-request' - '403': - $ref: '#/components/responses/forbidden' - '404': - $ref: '#/components/responses/not-found' - '405': - $ref: '#/components/responses/method-not-allowed' - '500': - $ref: '#/components/responses/internal-server-error' - '501': - $ref: '#/components/responses/not-implemented' - default: - $ref: '#/components/responses/default' - /aas/submodels/{submodelIdentifier}/submodel-elements/{idShortPath}/$metadata: - get: - tags: - - Asset Administration Shell API - summary: Returns the metadata attributes if a specific submodel element from the Submodel at a specified - path - operationId: GetSubmodelElementByPathMetadata - x-semanticIds: - - https://admin-shell.io/aas/API/GetSubmodelElementByPath/3/0 - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/SubmodelIdentifier' - - name: idShortPath - in: path - description: IdShort path to the submodel element (dot-separated) - required: true - style: simple - explode: false - schema: - type: string - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/From' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Size' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Level' - responses: - '200': - description: Requested submodel element - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/SubmodelElementMetadata' - '400': - $ref: '#/components/responses/bad-request' - '403': - $ref: '#/components/responses/forbidden' - '404': - $ref: '#/components/responses/not-found' - '405': - $ref: '#/components/responses/method-not-allowed' - '500': - $ref: '#/components/responses/internal-server-error' - '501': - $ref: '#/components/responses/not-implemented' - default: - $ref: '#/components/responses/default' - patch: - tags: - - Asset Administration Shell API - summary: Updates the metadata attributes of an existing submodel element value at a specified path within submodel elements hierarchy - operationId: PatchSubmodelElementValueByPathMetadata - x-semanticIds: - - https://admin-shell.io/aas/API/PatchSubmodelElementByPath/3/0 - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/SubmodelIdentifier' - - name: idShortPath - in: path - description: IdShort path to the submodel element (dot-separated) - required: true - style: simple - explode: false - schema: - type: string - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Level' - requestBody: - description: The updated metadata attributes of the submodel element - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/SubmodelElementMetadata' - required: true - responses: - '204': - description: Submodel element updated successfully - '400': - $ref: '#/components/responses/bad-request' - '403': - $ref: '#/components/responses/forbidden' - '404': - $ref: '#/components/responses/not-found' - '405': - $ref: '#/components/responses/method-not-allowed' - '500': - $ref: '#/components/responses/internal-server-error' - '501': - $ref: '#/components/responses/not-implemented' - default: - $ref: '#/components/responses/default' - /aas/submodels/{submodelIdentifier}/submodel-elements/{idShortPath}/$value: - get: - tags: - - Asset Administration Shell API - summary: Returns a specific submodel element from the Submodel at a specified - path in the ValueOnly representation - operationId: GetSubmodelElementByPathValueOnly - x-semanticIds: - - https://admin-shell.io/aas/API/GetSubmodelElementByPath/3/0 - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/SubmodelIdentifier' - - name: idShortPath - in: path - description: IdShort path to the submodel element (dot-separated) - required: true - style: simple - explode: false - schema: - type: string - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/From' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Size' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Level' - responses: - '200': - description: Requested submodel element in its ValueOnly representation - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/SubmodelElementValue' - '400': - $ref: '#/components/responses/bad-request' - '403': - $ref: '#/components/responses/forbidden' - '404': - $ref: '#/components/responses/not-found' - '405': - $ref: '#/components/responses/method-not-allowed' - '500': - $ref: '#/components/responses/internal-server-error' - '501': - $ref: '#/components/responses/not-implemented' - default: - $ref: '#/components/responses/default' - patch: - tags: - - Asset Administration Shell API - summary: Updates the value of an existing submodel element value at a specified path within submodel elements hierarchy - operationId: PatchSubmodelElementValueByPathValueOnly - x-semanticIds: - - https://admin-shell.io/aas/API/PatchSubmodelElementByPath/3/0 - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/SubmodelIdentifier' - - name: idShortPath - in: path - description: IdShort path to the submodel element (dot-separated) - required: true - style: simple - explode: false - schema: - type: string - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Level' - requestBody: - description: The updated value of the submodel element - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/SubmodelElementValue' - required: true - responses: - '204': - description: Submodel element updated successfully - '400': - $ref: '#/components/responses/bad-request' - '403': - $ref: '#/components/responses/forbidden' - '404': - $ref: '#/components/responses/not-found' - '405': - $ref: '#/components/responses/method-not-allowed' - '500': - $ref: '#/components/responses/internal-server-error' - '501': - $ref: '#/components/responses/not-implemented' - default: - $ref: '#/components/responses/default' - /aas/submodels/{submodelIdentifier}/submodel-elements/{idShortPath}/$reference: - get: - tags: - - Asset Administration Shell API - summary: Returns the Reference of a specific submodel element from the Submodel at a specified - path in the ValueOnly representation - operationId: GetSubmodelElementByPathReference - x-semanticIds: - - https://admin-shell.io/aas/API/GetSubmodelElementByPath/3/0 - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/SubmodelIdentifier' - - name: idShortPath - in: path - description: IdShort path to the submodel element (dot-separated) - required: true - style: simple - explode: false - schema: - type: string - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/From' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Size' - #- $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Level' - - name: level - in: query - description: Determines the structural depth of the respective resource content - required: false - schema: - type: string - default: core - enum: - # - deep - - core # only 'core' is allowed for Content=Reference - responses: - '200': - description: Requested submodel element in its ValueOnly representation - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0#/components/schemas/Reference' - '400': - $ref: '#/components/responses/bad-request' - '403': - $ref: '#/components/responses/forbidden' - '404': - $ref: '#/components/responses/not-found' - '405': - $ref: '#/components/responses/method-not-allowed' - '500': - $ref: '#/components/responses/internal-server-error' - '501': - $ref: '#/components/responses/not-implemented' - default: - $ref: '#/components/responses/default' - /aas/submodels/{submodelIdentifier}/submodel-elements/{idShortPath}/$path: - get: - tags: - - Asset Administration Shell API - summary: Returns a specific submodel element from the Submodel at a specified path in the Path notation - operationId: GetSubmodelElementByPathPath - x-semanticIds: - - https://admin-shell.io/aas/API/GetSubmodelElementByPath/3/0 - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/SubmodelIdentifier' - - name: idShortPath - in: path - description: IdShort path to the submodel element (dot-separated) - required: true - style: simple - explode: false - schema: - type: string - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/From' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Size' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Level' - responses: - '200': - description: Requested submodel element in the Path notation - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/PathItem' - '400': - $ref: '#/components/responses/bad-request' - '403': - $ref: '#/components/responses/forbidden' - '404': - $ref: '#/components/responses/not-found' - '405': - $ref: '#/components/responses/method-not-allowed' - '500': - $ref: '#/components/responses/internal-server-error' - '501': - $ref: '#/components/responses/not-implemented' - default: - $ref: '#/components/responses/default' - /aas/submodels/{submodelIdentifier}/submodel-elements/{idShortPath}/attachment: - get: - tags: - - Asset Administration Shell API - summary: Downloads file content from a specific submodel element from the Submodel at a specified path - operationId: GetFileByPath - x-semanticIds: - - https://admin-shell.io/aas/API/GetFileByPath/3/0 - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/SubmodelIdentifier' - - name: idShortPath - in: path - description: IdShort path to the submodel element (dot-separated) - required: true - style: simple - explode: false - schema: - type: string - responses: - '200': - description: Requested file - headers: - Content-Disposition: - schema: - type: string - description: In order to physically download the file usually set to attachment with a filename - example: 'attachment; filename="filename.jpg"' - content: - application/octet-stream: - schema: - type: string - format: binary - '400': - $ref: '#/components/responses/bad-request' - '403': - $ref: '#/components/responses/forbidden' - '404': - $ref: '#/components/responses/not-found' - '405': - $ref: '#/components/responses/method-not-allowed' - '500': - $ref: '#/components/responses/internal-server-error' - '501': - $ref: '#/components/responses/not-implemented' - default: - $ref: '#/components/responses/default' - put: - tags: - - Asset Administration Shell API - summary: Uploads file content to an existing submodel element at a specified path within submodel elements hierarchy - operationId: PutFileByPath - x-semanticIds: - - https://admin-shell.io/aas/API/PutFileByPath/3/0 - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/SubmodelIdentifier' - - name: idShortPath - in: path - description: IdShort path to the submodel element (dot-separated) - required: true - style: simple - explode: false - schema: - type: string - requestBody: - description: File to upload - content: - multipart/form-data: - schema: - type: object - properties: - fileName: - type: string - file: - type: string - format: binary - encoding: - file: - contentType: application/octet-stream - required: true - responses: - '204': - description: Submodel element updated successfully - '400': - $ref: '#/components/responses/bad-request' - '403': - $ref: '#/components/responses/forbidden' - '404': - $ref: '#/components/responses/not-found' - '405': - $ref: '#/components/responses/method-not-allowed' - '500': - $ref: '#/components/responses/internal-server-error' - '501': - $ref: '#/components/responses/not-implemented' - default: - $ref: '#/components/responses/default' - /aas/submodels/{submodelIdentifier}/submodel-elements/{idShortPath}/invoke: - post: - tags: - - Asset Administration Shell API - summary: Synchronously or asynchronously invokes an Operation at a specified path - operationId: InvokeOperation - x-semanticIds: - - https://admin-shell.io/aas/API/InvokeOperationSync/3/0 - - https://admin-shell.io/aas/API/InvokeOperationAsync/3/0 - parameters: - - name: async - in: query - description: Determines whether an operation invocation is performed asynchronously or synchronously - schema: - type: boolean - default: false - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Content' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/SubmodelIdentifier' - - name: idShortPath - in: path - description: IdShort path to the submodel element (dot-separated), in this case an operation - required: true - style: simple - explode: false - schema: - type: string - requestBody: - description: Operation request object - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/OperationRequest' - required: true - responses: - '200': - description: Operation result object - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/OperationResult' - '400': - $ref: '#/components/responses/bad-request' - '403': - $ref: '#/components/responses/forbidden' - '404': - $ref: '#/components/responses/not-found' - '405': - $ref: '#/components/responses/method-not-allowed' - '500': - $ref: '#/components/responses/internal-server-error' - '501': - $ref: '#/components/responses/not-implemented' - default: - $ref: '#/components/responses/default' - /aas/submodels/{submodelIdentifier}/submodel-elements/{idShortPath}/operation-results/{handleId}: - get: - tags: - - Asset Administration Shell API - summary: Returns the Operation result of an asynchronous invoked Operation - operationId: GetOperationAsyncResult - x-semanticIds: - - https://admin-shell.io/aas/API/GetOperationAsyncResult/3/0 - parameters: - - name: content - in: query - schema: - type: string - default: normal - enum: - - normal - - value - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/SubmodelIdentifier' - - name: idShortPath - in: path - description: IdShort path to the submodel element (dot-separated), in this case an operation - required: true - style: simple - explode: false - schema: - type: string - - name: handleId - in: path - description: The returned handle id of an operation’s asynchronous invocation used to request the current state of the operation’s execution (UTF8-BASE64-URL-encoded) - required: true - style: simple - explode: false - schema: - type: string - format: byte - responses: - '200': - description: Operation result object - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/OperationResult' - '400': - $ref: '#/components/responses/bad-request' - '403': - $ref: '#/components/responses/forbidden' - '404': - $ref: '#/components/responses/not-found' - '405': - $ref: '#/components/responses/method-not-allowed' - '500': - $ref: '#/components/responses/internal-server-error' - '501': - $ref: '#/components/responses/not-implemented' - default: - $ref: '#/components/responses/default' - - /serialization: - get: - tags: - - Asset Administration Shell Serialization API - summary: Returns an appropriate serialization based on the specified format (see SerializationFormat) - operationId: GenerateSerializationByIds - x-semanticIds: - - https://admin-shell.io/aas/API/GenerateSerializationByIds/3/0 - parameters: - - name: aasIds - in: query - description: The Asset Administration Shells' unique ids (UTF8-BASE64-URL-encoded) - required: true - style: form - explode: true - schema: - type: array - items: - type: string - - name: submodelIds - in: query - description: The Submodels' unique ids (UTF8-BASE64-URL-encoded) - required: true - style: form - explode: true - schema: - type: array - items: - type: string - - name: includeConceptDescriptions - in: query - description: Include Concept Descriptions? - required: true - style: form - explode: true - schema: - type: boolean - default: true - responses: - '200': - description: Requested serialization based on SerializationFormat - content: - application/asset-administration-shell-package+xml: - schema: - description: AASX package - type: string - format: binary - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0#/components/schemas/Environment' - application/xml: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0#/components/schemas/Environment' - '400': - $ref: '#/components/responses/bad-request' - '403': - $ref: '#/components/responses/forbidden' - '404': - $ref: '#/components/responses/not-found' - '405': - $ref: '#/components/responses/method-not-allowed' - '500': - $ref: '#/components/responses/internal-server-error' - '501': - $ref: '#/components/responses/not-implemented' - default: - $ref: '#/components/responses/default' -components: - responses: - 'no-content': - description: No Content, request was successful but no content is returned - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0#/components/schemas/AssetAdministrationShell' - 'bad-request': - description: Bad Request, e.g. the request parameters of the format of the request body is wrong. - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/Result' - 'forbidden': - description: Forbidden - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/Result' - 'not-found': - description: Not Found - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/Result' - 'method-not-allowed': - description: Method Not Allowed, the server does not offer this method for the client - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/Result' - 'internal-server-error': - description: Internal Server Error - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/Result' - 'not-implemented': - description: Method Not Implemented by the server - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/Result' - 'default': - description: Default error handling for unmentioned status codes - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/Result' \ No newline at end of file diff --git a/AssetAdministrationShell-Environment/openapi.yaml b/AssetAdministrationShell-Environment/openapi.yaml deleted file mode 100644 index 3f3d89ac..00000000 --- a/AssetAdministrationShell-Environment/openapi.yaml +++ /dev/null @@ -1,2136 +0,0 @@ -openapi: 3.0.3 -info: - title: DotAAS Part 2 | HTTP/REST | Asset Administration Shell Environment API - description: An exemplary API combination for the use case of an Asset Administration Shell Environment - contact: - name: Constantin Ziesche, Andreas Orzelski, Florian Krebs, Bastian Rössl, Manuel Sauer, Jens Vialkowitsch, Michael Hoffmeister, Torben Miny, Sebastian Bader, Marko Ristin, Nico Braunisch - version: V1.0RC03 - termsOfService: https://github.com/admin-shell-io/aas-specs -servers: -- url: '{protocol}://{host_name}:{port}/api/{version_prefix}' - variables: - protocol: - description: 'Allows access through http and https (recommended)' - enum: - - 'http' - - 'https' - default: 'https' - host_name: - default: admin-shell.io - description: 'Hostname of server hosting the api' - port: - enum: - - '80' - - '443' - default: '443' - description: '80 is default for http, 443 for https' - version_prefix: - enum: - - 'v1' - default: v1 -paths: - /shells: - get: - tags: - - Asset Administration Shell Environment API - summary: Returns all Asset Administration Shells - operationId: GetAllAssetAdministrationShells - x-semanticIds: - - https://admin-shell.io/aas/API/GetAllAssetAdministrationShells/1/0/RC03 - - https://admin-shell.io/aas/API/GetAllAssetAdministrationShellsByAssetId/1/0/RC03 - - https://admin-shell.io/aas/API/GetAllAssetAdministrationShellsByIdShort/1/0/RC03 - parameters: - - name: assetIds - in: query - description: A list of specific Asset identifiers - required: false - style: form - explode: true - schema: - type: array - items: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0RC02#/components/schemas/SpecificAssetId' - example: '[ { "name": "some-asset-id", "value": "http://example-company.com/myAsset", "externalSubjectId": { "keys": [ { "type": "GlobalReference", "value": "http://example-company.com/example-companys-asset-keys" } ], "type": "GlobalReference" } }, { "name": "some-other-asset-id", "value": "12345ABC", "externalSubjectId": { "keys": [ { "type": "GlobalReference", "value": "http://my-own-company.com/keys" } ], "type": "GlobalReference" } } ]e": "globalAssetId","value": "http://example.company/myAsset", "externalSubjectId": "http://example.company"},{"name": "myOwnInternalAssetId","value": "12345ABC", "externalSubjectId": "http://example.company"}]' - - name: idShort - in: query - description: The Asset Administration Shell’s IdShort - required: false - style: form - explode: true - schema: - type: string - responses: - '200': - description: Requested Asset Administration Shells - content: - application/json: - schema: - type: array - items: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0RC02#/components/schemas/AssetAdministrationShell' - default: - description: Default error handling for unmentioned status codes - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V1.0RC03#/components/schemas/Result' - post: - tags: - - Asset Administration Shell Environment API - summary: Creates a new Asset Administration Shell - operationId: PostAssetAdministrationShell - x-semanticIds: - - https://admin-shell.io/aas/API/PostAssetAdministrationShell/1/0/RC03 - requestBody: - description: Asset Administration Shell object - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0RC02#/components/schemas/AssetAdministrationShell' - required: true - responses: - '201': - description: Asset Administration Shell created successfully - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0RC02#/components/schemas/AssetAdministrationShell' - '400': - description: Bad Request - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V1.0RC03#/components/schemas/Result' - default: - description: Default error handling for unmentioned status codes - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V1.0RC03#/components/schemas/Result' - /shells/{aasIdentifier}: - get: - tags: - - Asset Administration Shell Environment API - summary: Returns a specific Asset Administration Shell - operationId: GetAssetAdministrationShellById - x-semanticIds: - - https://admin-shell.io/aas/API/GetAssetAdministrationShellById/1/0/RC03 - parameters: - - name: aasIdentifier - in: path - description: The Asset Administration Shell’s unique id (UTF8-BASE64-URL-encoded) - required: true - style: simple - explode: false - schema: - type: string - format: byte - responses: - '200': - description: Requested Asset Administration Shell - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0RC02#/components/schemas/AssetAdministrationShell' - '404': - description: Not Found - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V1.0RC03#/components/schemas/Result' - default: - description: Default error handling for unmentioned status codes - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V1.0RC03#/components/schemas/Result' - put: - tags: - - Asset Administration Shell Environment API - summary: Updates an existing Asset Administration Shell - operationId: PutAssetAdministrationShellById - x-semanticIds: - - https://admin-shell.io/aas/API/PutAssetAdministrationShellById/1/0/RC03 - parameters: - - name: aasIdentifier - in: path - description: The Asset Administration Shell’s unique id (UTF8-BASE64-URL-encoded) - required: true - style: simple - explode: false - schema: - type: string - format: byte - requestBody: - description: Asset Administration Shell object - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0RC02#/components/schemas/AssetAdministrationShell' - required: true - responses: - '204': - description: Asset Administration Shell updated successfully - '400': - description: Bad Request - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V1.0RC03#/components/schemas/Result' - '404': - description: Not Found - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V1.0RC03#/components/schemas/Result' - default: - description: Default error handling for unmentioned status codes - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V1.0RC03#/components/schemas/Result' - delete: - tags: - - Asset Administration Shell Environment API - summary: Deletes an Asset Administration Shell - operationId: DeleteAssetAdministrationShellById - x-semanticIds: - - https://admin-shell.io/aas/API/DeleteAssetAdministrationShellById/1/0/RC03 - parameters: - - name: aasIdentifier - in: path - description: The Asset Administration Shell’s unique id (UTF8-BASE64-URL-encoded) - required: true - style: simple - explode: false - schema: - type: string - format: byte - responses: - '204': - description: Asset Administration Shell deleted successfully - '404': - description: Not Found - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V1.0RC03#/components/schemas/Result' - default: - description: Default error handling for unmentioned status codes - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V1.0RC03#/components/schemas/Result' - /shells/{aasIdentifier}/asset-information: - get: - tags: - - Asset Administration Shell Environment API - summary: Returns the Asset Information - operationId: GetAssetInformation - x-semanticIds: - - https://admin-shell.io/aas/API/GetAssetInformation/1/0/RC03 - parameters: - - name: aasIdentifier - in: path - description: The Asset Administration Shell’s unique id (UTF8-BASE64-URL-encoded) - required: true - style: simple - explode: false - schema: - type: string - format: byte - responses: - '200': - description: Requested Asset Information - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0RC02#/components/schemas/AssetInformation' - default: - description: Default error handling for unmentioned status codes - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V1.0RC03#/components/schemas/Result' - put: - tags: - - Asset Administration Shell Environment API - summary: Updates the Asset Information - operationId: PutAssetInformation - x-semanticIds: - - https://admin-shell.io/aas/API/PutAssetInformation/1/0/RC03 - parameters: - - name: aasIdentifier - in: path - description: The Asset Administration Shell’s unique id (UTF8-BASE64-URL-encoded) - required: true - style: simple - explode: false - schema: - type: string - format: byte - requestBody: - description: Asset Information object - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0RC02#/components/schemas/AssetInformation' - required: true - responses: - '204': - description: Asset Information updated successfully - '400': - description: Bad Request - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V1.0RC03#/components/schemas/Result' - default: - description: Default error handling for unmentioned status codes - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V1.0RC03#/components/schemas/Result' - /shells/{aasIdentifier}/submodels: - get: - tags: - - Asset Administration Shell Environment API - summary: Returns all submodel references - operationId: GetAllSubmodelReferences - x-semanticIds: - - https://admin-shell.io/aas/API/GetAllSubmodelReferences/1/0/RC03 - parameters: - - name: aasIdentifier - in: path - description: The Asset Administration Shell’s unique id (UTF8-BASE64-URL-encoded) - required: true - style: simple - explode: false - schema: - type: string - format: byte - responses: - '200': - description: Requested submodel references - content: - application/json: - schema: - type: array - items: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0RC02#/components/schemas/Reference' - default: - description: Default error handling for unmentioned status codes - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V1.0RC03#/components/schemas/Result' - post: - tags: - - Asset Administration Shell Environment API - summary: Creates a submodel reference at the Asset Administration Shell - operationId: PostSubmodelReference - x-semanticIds: - - https://admin-shell.io/aas/API/PostSubmodelReference/1/0/RC03 - parameters: - - name: aasIdentifier - in: path - description: The Asset Administration Shell’s unique id (UTF8-BASE64-URL-encoded) - required: true - style: simple - explode: false - schema: - type: string - format: byte - requestBody: - description: Reference to the Submodel - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0RC02#/components/schemas/Reference' - required: true - responses: - '201': - description: Submodel reference created successfully - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0RC02#/components/schemas/Reference' - '400': - description: Bad Request - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V1.0RC03#/components/schemas/Result' - default: - description: Default error handling for unmentioned status codes - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V1.0RC03#/components/schemas/Result' - /shells/{aasIdentifier}/submodels/{submodelIdentifier}: - delete: - tags: - - Asset Administration Shell Environment API - summary: Deletes the submodel reference from the Asset Administration Shell - operationId: DeleteSubmodelReferenceById - x-semanticIds: - - https://admin-shell.io/aas/API/DeleteSubmodelReference/1/0/RC03 - parameters: - - name: aasIdentifier - in: path - description: The Asset Administration Shell’s unique id (UTF8-BASE64-URL-encoded) - required: true - style: simple - explode: false - schema: - type: string - format: byte - - name: submodelIdentifier - in: path - description: The Submodel’s unique id (UTF8-BASE64-URL-encoded) - required: true - style: simple - explode: false - schema: - type: string - format: byte - responses: - '204': - description: Submodel reference deleted successfully - '404': - description: Not Found - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V1.0RC03#/components/schemas/Result' - default: - description: Default error handling for unmentioned status codes - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V1.0RC03#/components/schemas/Result' - /shells/{aasIdentifier}/submodels/{submodelIdentifier}/submodel: - get: - tags: - - Asset Administration Shell Environment API - summary: Returns the Submodel - operationId: GetSubmodel - x-semanticIds: - - https://admin-shell.io/aas/API/GetSubmodel/1/0/RC03 - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V1.0RC03#/components/parameters/Level' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V1.0RC03#/components/parameters/Content' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V1.0RC03#/components/parameters/Extent' - - name: aasIdentifier - in: path - description: The Asset Administration Shell’s unique id (UTF8-BASE64-URL-encoded) - required: true - style: simple - explode: false - schema: - type: string - format: byte - - name: submodelIdentifier - in: path - description: The Submodel’s unique id (UTF8-BASE64-URL-encoded) - required: true - style: simple - explode: false - schema: - type: string - format: byte - responses: - '200': - description: Requested Submodel - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0RC02#/components/schemas/Submodel' - default: - description: Default error handling for unmentioned status codes - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V1.0RC03#/components/schemas/Result' - put: - tags: - - Asset Administration Shell Environment API - summary: Updates the Submodel - operationId: PutSubmodel - x-semanticIds: - - https://admin-shell.io/aas/API/PutSubmodel/1/0/RC03 - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V1.0RC03#/components/parameters/Level' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V1.0RC03#/components/parameters/Content' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V1.0RC03#/components/parameters/Extent' - - name: aasIdentifier - in: path - description: The Asset Administration Shell’s unique id (UTF8-BASE64-URL-encoded) - required: true - style: simple - explode: false - schema: - type: string - format: byte - - name: submodelIdentifier - in: path - description: The Submodel’s unique id (UTF8-BASE64-URL-encoded) - required: true - style: simple - explode: false - schema: - type: string - format: byte - requestBody: - description: Submodel object - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0RC02#/components/schemas/Submodel' - required: true - responses: - '204': - description: Submodel updated successfully - '400': - description: Bad Request - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V1.0RC03#/components/schemas/Result' - default: - description: Default error handling for unmentioned status codes - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V1.0RC03#/components/schemas/Result' - /shells/{aasIdentifier}/submodels/{submodelIdentifier}/submodel/submodel-elements: - get: - tags: - - Asset Administration Shell Environment API - summary: Returns all submodel elements including their hierarchy - operationId: GetAllSubmodelElements - x-semanticIds: - - https://admin-shell.io/aas/API/GetAllSubmodelElements/1/0/RC03 - - https://admin-shell.io/aas/API/GetAllSubmodelElementsBySemanticId/1/0/RC03 - - https://admin-shell.io/aas/API/GetAllSubmodelElementsByParentPathAndSemanticId/1/0/RC03 - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V1.0RC03#/components/parameters/Level' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V1.0RC03#/components/parameters/Content' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V1.0RC03#/components/parameters/Extent' - - name: aasIdentifier - in: path - description: The Asset Administration Shell’s unique id (UTF8-BASE64-URL-encoded) - required: true - style: simple - explode: false - schema: - type: string - format: byte - - name: submodelIdentifier - in: path - description: The Submodel’s unique id (UTF8-BASE64-URL-encoded) - required: true - style: simple - explode: false - schema: - type: string - format: byte - responses: - '200': - description: List of found submodel elements - content: - application/json: - schema: - type: array - items: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0RC02#/components/schemas/SubmodelElement' - default: - description: Default error handling for unmentioned status codes - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V1.0RC03#/components/schemas/Result' - post: - tags: - - Asset Administration Shell Environment API - summary: Creates a new submodel element - operationId: PostSubmodelElement - x-semanticIds: - - https://admin-shell.io/aas/API/PostSubmodelElement/1/0/RC03c - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V1.0RC03#/components/parameters/Level' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V1.0RC03#/components/parameters/Content' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V1.0RC03#/components/parameters/Extent' - - name: aasIdentifier - in: path - description: The Asset Administration Shell’s unique id (UTF8-BASE64-URL-encoded) - required: true - style: simple - explode: false - schema: - type: string - format: byte - - name: submodelIdentifier - in: path - description: The Submodel’s unique id (UTF8-BASE64-URL-encoded) - required: true - style: simple - explode: false - schema: - type: string - format: byte - requestBody: - description: Requested submodel element - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0RC02#/components/schemas/SubmodelElement' - required: true - responses: - '201': - description: Submodel element created successfully - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0RC02#/components/schemas/SubmodelElement' - '400': - description: Bad Request - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V1.0RC03#/components/schemas/Result' - default: - description: Default error handling for unmentioned status codes - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V1.0RC03#/components/schemas/Result' - /shells/{aasIdentifier}/submodels/{submodelIdentifier}/submodel/submodel-elements/{idShortPath}: - get: - tags: - - Asset Administration Shell Environment API - summary: Returns a specific submodel element from the Submodel at a specified - path - operationId: GetSubmodelElementByPath - x-semanticIds: - - https://admin-shell.io/aas/API/GetSubmodelElementByPath/1/0/RC03 - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V1.0RC03#/components/parameters/Level' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V1.0RC03#/components/parameters/Content' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V1.0RC03#/components/parameters/Extent' - - name: aasIdentifier - in: path - description: The Asset Administration Shell’s unique id (UTF8-BASE64-URL-encoded) - required: true - style: simple - explode: false - schema: - type: string - format: byte - - name: submodelIdentifier - in: path - description: The Submodel’s unique id (UTF8-BASE64-URL-encoded) - required: true - style: simple - explode: false - schema: - type: string - format: byte - - name: idShortPath - in: path - description: IdShort path to the submodel element (dot-separated) - required: true - style: simple - explode: false - schema: - type: string - responses: - '200': - description: Requested submodel element - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0RC02#/components/schemas/SubmodelElement' - '404': - description: Not Found - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V1.0RC03#/components/schemas/Result' - default: - description: Default error handling for unmentioned status codes - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V1.0RC03#/components/schemas/Result' - post: - tags: - - Asset Administration Shell Environment API - summary: Creates a new submodel element at a specified path within submodel elements hierarchy - operationId: PostSubmodelElementByPath - x-semanticIds: - - https://admin-shell.io/aas/API/PostSubmodelElementByPath/1/0/RC03c - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V1.0RC03#/components/parameters/Level' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V1.0RC03#/components/parameters/Content' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V1.0RC03#/components/parameters/Extent' - - name: aasIdentifier - in: path - description: The Asset Administration Shell’s unique id (UTF8-BASE64-URL-encoded) - required: true - style: simple - explode: false - schema: - type: string - format: byte - - name: submodelIdentifier - in: path - description: The Submodel’s unique id (UTF8-BASE64-URL-encoded) - required: true - style: simple - explode: false - schema: - type: string - format: byte - - name: idShortPath - in: path - description: IdShort path to the submodel element (dot-separated) - required: true - style: simple - explode: false - schema: - type: string - requestBody: - description: Requested submodel element - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0RC02#/components/schemas/SubmodelElement' - required: true - responses: - '201': - description: Submodel element created successfully - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0RC02#/components/schemas/SubmodelElement' - '400': - description: Bad Request - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V1.0RC03#/components/schemas/Result' - '404': - description: Not Found - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V1.0RC03#/components/schemas/Result' - default: - description: Default error handling for unmentioned status codes - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V1.0RC03#/components/schemas/Result' - put: - tags: - - Asset Administration Shell Environment API - summary: Updates an existing submodel element at a specified path within submodel elements hierarchy - operationId: PutSubmodelElementByPath - x-semanticIds: - - https://admin-shell.io/aas/API/PutSubmodelElementByPath/1/0/RC03 - - https://admin-shell.io/aas/API/SetSubmodelElementValueByPath/1/0/RC03 - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V1.0RC03#/components/parameters/Level' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V1.0RC03#/components/parameters/Content' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V1.0RC03#/components/parameters/Extent' - - name: aasIdentifier - in: path - description: The Asset Administration Shell’s unique id (UTF8-BASE64-URL-encoded) - required: true - style: simple - explode: false - schema: - type: string - format: byte - - name: submodelIdentifier - in: path - description: The Submodel’s unique id (UTF8-BASE64-URL-encoded) - required: true - style: simple - explode: false - schema: - type: string - format: byte - - name: idShortPath - in: path - description: IdShort path to the submodel element (dot-separated) - required: true - style: simple - explode: false - schema: - type: string - requestBody: - description: Requested submodel element - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0RC02#/components/schemas/SubmodelElement' - required: true - responses: - '204': - description: Submodel element updated successfully - '400': - description: Bad Request - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V1.0RC03#/components/schemas/Result' - '404': - description: Not Found - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V1.0RC03#/components/schemas/Result' - default: - description: Default error handling for unmentioned status codes - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V1.0RC03#/components/schemas/Result' - delete: - tags: - - Asset Administration Shell Environment API - summary: Deletes a submodel element at a specified path within the submodel elements hierarchy - operationId: DeleteSubmodelElementByPath - x-semanticIds: - - https://admin-shell.io/aas/API/DeleteSubmodelElementByPath/1/0/RC03 - parameters: - - name: aasIdentifier - in: path - description: The Asset Administration Shell’s unique id (UTF8-BASE64-URL-encoded) - required: true - style: simple - explode: false - schema: - type: string - format: byte - - name: submodelIdentifier - in: path - description: The Submodel’s unique id (UTF8-BASE64-URL-encoded) - required: true - style: simple - explode: false - schema: - type: string - format: byte - - name: idShortPath - in: path - description: IdShort path to the submodel element (dot-separated) - required: true - style: simple - explode: false - schema: - type: string - responses: - '204': - description: Submodel element deleted successfully - '404': - description: Not Found - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V1.0RC03#/components/schemas/Result' - default: - description: Default error handling for unmentioned status codes - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V1.0RC03#/components/schemas/Result' - /shells/{aasIdentifier}/submodels/{submodelIdentifier}/submodel/submodel-elements/{idShortPath}/attachment: - get: - tags: - - Asset Administration Shell Environment API - summary: Downloads file content from a specific submodel element from the Submodel at a specified path - operationId: GetFileByPath - x-semanticIds: - - https://admin-shell.io/aas/API/GetFileByPath/1/0/RC03 - parameters: - - name: aasIdentifier - in: path - description: The Asset Administration Shell’s unique id (UTF8-BASE64-URL-encoded) - required: true - style: simple - explode: false - schema: - type: string - format: byte - - name: submodelIdentifier - in: path - description: The Submodel’s unique id (UTF8-BASE64-URL-encoded) - required: true - style: simple - explode: false - schema: - type: string - format: byte - - name: idShortPath - in: path - description: IdShort path to the submodel element (dot-separated) - required: true - style: simple - explode: false - schema: - type: string - responses: - '200': - description: Requested file - headers: - Content-Disposition: - schema: - type: string - description: In order to physically download the file usually set to attachment with a filename - example: 'attachment; filename="filename.jpg"' - content: - application/octet-stream: - schema: - type: string - format: binary - '404': - description: Not Found - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V1.0RC03#/components/schemas/Result' - '405': - description: Method not allowed - Download only valid for File submodel element - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V1.0RC03#/components/schemas/Result' - default: - description: Default error handling for unmentioned status codes - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V1.0RC03#/components/schemas/Result' - put: - tags: - - Asset Administration Shell Environment API - summary: Uploads file content to an existing submodel element at a specified path within submodel elements hierarchy - operationId: PutFileByPath - x-semanticIds: - - https://admin-shell.io/aas/API/PutFileByPath/1/0/RC03 - parameters: - - name: aasIdentifier - in: path - description: The Asset Administration Shell’s unique id (UTF8-BASE64-URL-encoded) - required: true - style: simple - explode: false - schema: - type: string - format: byte - - name: submodelIdentifier - in: path - description: The Submodel’s unique id (UTF8-BASE64-URL-encoded) - required: true - style: simple - explode: false - schema: - type: string - format: byte - - name: idShortPath - in: path - description: IdShort path to the submodel element (dot-separated) - required: true - style: simple - explode: false - schema: - type: string - requestBody: - description: File to upload - content: - multipart/form-data: - schema: - type: object - properties: - fileName: - type: string - file: - type: string - format: binary - encoding: - file: - contentType: application/octet-stream - required: true - responses: - '204': - description: Submodel element updated successfully - '400': - description: Bad Request - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V1.0RC03#/components/schemas/Result' - '404': - description: Not Found - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V1.0RC03#/components/schemas/Result' - '405': - description: Method not allowed - Upload only valid for File submodel element - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V1.0RC03#/components/schemas/Result' - default: - description: Default error handling for unmentioned status codes - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V1.0RC03#/components/schemas/Result' - /shells/{aasIdentifier}/submodels/{submodelIdentifier}/submodel/submodel-elements/{idShortPath}/invoke: - post: - tags: - - Asset Administration Shell Environment API - summary: Synchronously or asynchronously invokes an Operation at a specified path - operationId: InvokeOperation - x-semanticIds: - - https://admin-shell.io/aas/API/InvokeOperationSync/1/0/RC03 - - https://admin-shell.io/aas/API/InvokeOperationAsync/1/0/RC03 - parameters: - - name: async - in: query - description: Determines whether an operation invocation is performed asynchronously or synchronously - schema: - type: boolean - default: false - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V1.0RC03#/components/parameters/Content' - - name: aasIdentifier - in: path - description: The Asset Administration Shell’s unique id (UTF8-BASE64-URL-encoded) - required: true - style: simple - explode: false - schema: - type: string - format: byte - - name: submodelIdentifier - in: path - description: The Submodel’s unique id (UTF8-BASE64-URL-encoded) - required: true - style: simple - explode: false - schema: - type: string - format: byte - - name: idShortPath - in: path - description: IdShort path to the submodel element (dot-separated), in this case an operation - required: true - style: simple - explode: false - schema: - type: string - requestBody: - description: Operation request object - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V1.0RC03#/components/schemas/OperationRequest' - required: true - responses: - '200': - description: Operation result object - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V1.0RC03#/components/schemas/OperationResult' - '400': - description: Bad Request - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V1.0RC03#/components/schemas/Result' - '404': - description: Not Found - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V1.0RC03#/components/schemas/Result' - '405': - description: Method not allowed - Invoke only valid for Operation submodel element - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V1.0RC03#/components/schemas/Result' - default: - description: Default error handling for unmentioned status codes - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V1.0RC03#/components/schemas/Result' - /shells/{aasIdentifier}/submodels/{submodelIdentifier}/submodel/submodel-elements/{idShortPath}/operation-results/{handleId}: - get: - tags: - - Asset Administration Shell Environment API - summary: Returns the Operation result of an asynchronous invoked Operation - operationId: GetOperationAsyncResult - x-semanticIds: - - https://admin-shell.io/aas/API/GetOperationAsyncResult/1/0/RC03 - parameters: - - name: content - in: query - schema: - type: string - default: normal - enum: - - normal - - value - - name: aasIdentifier - in: path - description: The Asset Administration Shell’s unique id (UTF8-BASE64-URL-encoded) - required: true - style: simple - explode: false - schema: - type: string - format: byte - - name: submodelIdentifier - in: path - description: The Submodel’s unique id (UTF8-BASE64-URL-encoded) - required: true - style: simple - explode: false - schema: - type: string - format: byte - - name: idShortPath - in: path - description: IdShort path to the submodel element (dot-separated), in this case an operation - required: true - style: simple - explode: false - schema: - type: string - - name: handleId - in: path - description: The returned handle id of an operation’s asynchronous invocation used to request the current state of the operation’s execution (UTF8-BASE64-URL-encoded) - required: true - style: simple - explode: false - schema: - type: string - format: byte - responses: - '200': - description: Operation result object - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V1.0RC03#/components/schemas/OperationResult' - '404': - description: Not Found - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V1.0RC03#/components/schemas/Result' - default: - description: Default error handling for unmentioned status codes - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V1.0RC03#/components/schemas/Result' - /submodels: - get: - tags: - - Asset Administration Shell Environment API - summary: Returns all Submodels - operationId: GetAllSubmodels - x-semanticIds: - - https://admin-shell.io/aas/API/GetAllSubmodels/1/0/RC03 - - https://admin-shell.io/aas/API/GetAllSubmodelsBySemanticId/1/0/RC03 - - https://admin-shell.io/aas/API/GetAllSubmodelsByIdShort/1/0/RC03 - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V1.0RC03#/components/parameters/SemanticId' - - name: idShort - in: query - description: The Submodel’s idShort - required: false - style: form - explode: true - schema: - type: string - responses: - '200': - description: Requested Submodels - content: - application/json: - schema: - type: array - items: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0RC02#/components/schemas/Submodel' - default: - description: Default error handling for unmentioned status codes - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V1.0RC03#/components/schemas/Result' - post: - tags: - - Asset Administration Shell Environment API - summary: Creates a new Submodel - operationId: PostSubmodel - x-semanticIds: - - https://admin-shell.io/aas/API/PostSubmodel/1/0/RC03 - requestBody: - description: Submodel object - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0RC02#/components/schemas/Submodel' - required: true - responses: - '201': - description: Submodel created successfully - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0RC02#/components/schemas/Submodel' - '400': - description: Bad Request - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V1.0RC03#/components/schemas/Result' - default: - description: Default error handling for unmentioned status codes - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V1.0RC03#/components/schemas/Result' - /submodels/{submodelIdentifier}: - get: - tags: - - Asset Administration Shell Environment API - summary: Returns a specific Submodel - operationId: GetSubmodelById - x-semanticIds: - - https://admin-shell.io/aas/API/GetSubmodelById/1/0/RC03 - parameters: - - name: submodelIdentifier - in: path - description: The Submodel’s unique id (UTF8-BASE64-URL-encoded) - required: true - style: simple - explode: false - schema: - type: string - format: byte - responses: - '200': - description: Requested Submodel - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0RC02#/components/schemas/Submodel' - '404': - description: Not Found - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V1.0RC03#/components/schemas/Result' - default: - description: Default error handling for unmentioned status codes - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V1.0RC03#/components/schemas/Result' - put: - tags: - - Asset Administration Shell Environment API - summary: Updates an existing Submodel - operationId: PutSubmodelById - x-semanticIds: - - https://admin-shell.io/aas/API/PutSubmodelById/1/0/RC03 - parameters: - - name: submodelIdentifier - in: path - description: The Submodel’s unique id (UTF8-BASE64-URL-encoded) - required: true - style: simple - explode: false - schema: - type: string - format: byte - requestBody: - description: Submodel object - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0RC02#/components/schemas/Submodel' - required: true - responses: - '204': - description: Submodel updated successfully - '400': - description: Bad Request - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V1.0RC03#/components/schemas/Result' - '404': - description: Not Found - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V1.0RC03#/components/schemas/Result' - default: - description: Default error handling for unmentioned status codes - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V1.0RC03#/components/schemas/Result' - delete: - tags: - - Asset Administration Shell Environment API - summary: Deletes a Submodel - operationId: DeleteSubmodelById - x-semanticIds: - - https://admin-shell.io/aas/API/DeleteSubmodelById/1/0/RC03 - parameters: - - name: submodelIdentifier - in: path - description: The Submodel’s unique id (UTF8-BASE64-URL-encoded) - required: true - style: simple - explode: false - schema: - type: string - format: byte - responses: - '204': - description: Submodel deleted successfully - '404': - description: Not Found - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V1.0RC03#/components/schemas/Result' - default: - description: Default error handling for unmentioned status codes - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V1.0RC03#/components/schemas/Result' - /submodels/{submodelIdentifier}/submodel-elements: - get: - tags: - - Asset Administration Shell Environment API - summary: Returns all submodel elements including their hierarchy - operationId: GetAllSubmodelElements_SubmodelRepo - x-semanticIds: - - https://admin-shell.io/aas/API/GetAllSubmodelElements/1/0/RC03 - - https://admin-shell.io/aas/API/GetAllSubmodelElementsBySemanticId/1/0/RC03 - - https://admin-shell.io/aas/API/GetAllSubmodelElementsByParentPathAndSemanticId/1/0/RC03 - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V1.0RC03#/components/parameters/Level' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V1.0RC03#/components/parameters/Content' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V1.0RC03#/components/parameters/Extent' - - name: submodelIdentifier - in: path - description: The Submodel’s unique id (UTF8-BASE64-URL-encoded) - required: true - style: simple - explode: false - schema: - type: string - format: byte - responses: - '200': - description: List of found submodel elements - content: - application/json: - schema: - type: array - items: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0RC02#/components/schemas/SubmodelElement' - default: - description: Default error handling for unmentioned status codes - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V1.0RC03#/components/schemas/Result' - post: - tags: - - Asset Administration Shell Environment API - summary: Creates a new submodel element - operationId: PostSubmodelElement_SubmodelRepo - x-semanticIds: - - https://admin-shell.io/aas/API/PostSubmodelElement/1/0/RC03c - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V1.0RC03#/components/parameters/Level' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V1.0RC03#/components/parameters/Content' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V1.0RC03#/components/parameters/Extent' - - name: submodelIdentifier - in: path - description: The Submodel’s unique id (UTF8-BASE64-URL-encoded) - required: true - style: simple - explode: false - schema: - type: string - format: byte - requestBody: - description: Requested submodel element - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0RC02#/components/schemas/SubmodelElement' - required: true - responses: - '201': - description: Submodel element created successfully - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0RC02#/components/schemas/SubmodelElement' - '400': - description: Bad Request - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V1.0RC03#/components/schemas/Result' - default: - description: Default error handling for unmentioned status codes - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V1.0RC03#/components/schemas/Result' - /submodels/{submodelIdentifier}/submodel-elements/{idShortPath}: - get: - tags: - - Asset Administration Shell Environment API - summary: Returns a specific submodel element from the Submodel at a specified - path - operationId: GetSubmodelElementByPath_SubmodelRepo - x-semanticIds: - - https://admin-shell.io/aas/API/GetSubmodelElementByPath/1/0/RC03 - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V1.0RC03#/components/parameters/Level' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V1.0RC03#/components/parameters/Content' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V1.0RC03#/components/parameters/Extent' - - name: submodelIdentifier - in: path - description: The Submodel’s unique id (UTF8-BASE64-URL-encoded) - required: true - style: simple - explode: false - schema: - type: string - format: byte - - name: idShortPath - in: path - description: IdShort path to the submodel element (dot-separated) - required: true - style: simple - explode: false - schema: - type: string - responses: - '200': - description: Requested submodel element - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0RC02#/components/schemas/SubmodelElement' - '404': - description: Not Found - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V1.0RC03#/components/schemas/Result' - default: - description: Default error handling for unmentioned status codes - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V1.0RC03#/components/schemas/Result' - post: - tags: - - Asset Administration Shell Environment API - summary: Creates a new submodel element at a specified path within submodel elements hierarchy - operationId: PostSubmodelElementByPath_SubmodelRepo - x-semanticIds: - - https://admin-shell.io/aas/API/PostSubmodelElementByPath/1/0/RC03c - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V1.0RC03#/components/parameters/Level' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V1.0RC03#/components/parameters/Content' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V1.0RC03#/components/parameters/Extent' - - name: submodelIdentifier - in: path - description: The Submodel’s unique id (UTF8-BASE64-URL-encoded) - required: true - style: simple - explode: false - schema: - type: string - format: byte - - name: idShortPath - in: path - description: IdShort path to the submodel element (dot-separated) - required: true - style: simple - explode: false - schema: - type: string - requestBody: - description: Requested submodel element - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0RC02#/components/schemas/SubmodelElement' - required: true - responses: - '201': - description: Submodel element created successfully - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0RC02#/components/schemas/SubmodelElement' - '400': - description: Bad Request - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V1.0RC03#/components/schemas/Result' - '404': - description: Not Found - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V1.0RC03#/components/schemas/Result' - default: - description: Default error handling for unmentioned status codes - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V1.0RC03#/components/schemas/Result' - put: - tags: - - Asset Administration Shell Environment API - summary: Updates an existing submodel element at a specified path within submodel elements hierarchy - operationId: PutSubmodelElementByPath_SubmodelRepo - x-semanticIds: - - https://admin-shell.io/aas/API/PutSubmodelElementByPath/1/0/RC03 - - https://admin-shell.io/aas/API/SetSubmodelElementValueByPath/1/0/RC03 - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V1.0RC03#/components/parameters/Level' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V1.0RC03#/components/parameters/Content' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V1.0RC03#/components/parameters/Extent' - - name: submodelIdentifier - in: path - description: The Submodel’s unique id (UTF8-BASE64-URL-encoded) - required: true - style: simple - explode: false - schema: - type: string - format: byte - - name: idShortPath - in: path - description: IdShort path to the submodel element (dot-separated) - required: true - style: simple - explode: false - schema: - type: string - requestBody: - description: Requested submodel element - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0RC02#/components/schemas/SubmodelElement' - required: true - responses: - '204': - description: Submodel element updated successfully - '400': - description: Bad Request - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V1.0RC03#/components/schemas/Result' - '404': - description: Not Found - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V1.0RC03#/components/schemas/Result' - default: - description: Default error handling for unmentioned status codes - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V1.0RC03#/components/schemas/Result' - delete: - tags: - - Asset Administration Shell Environment API - summary: Deletes a submodel element at a specified path within the submodel elements hierarchy - operationId: DeleteSubmodelElementByPath_SubmodelRepo - x-semanticIds: - - https://admin-shell.io/aas/API/DeleteSubmodelElementByPath/1/0/RC03 - parameters: - - name: submodelIdentifier - in: path - description: The Submodel’s unique id (UTF8-BASE64-URL-encoded) - required: true - style: simple - explode: false - schema: - type: string - format: byte - - name: idShortPath - in: path - description: IdShort path to the submodel element (dot-separated) - required: true - style: simple - explode: false - schema: - type: string - responses: - '204': - description: Submodel element deleted successfully - '404': - description: Not Found - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V1.0RC03#/components/schemas/Result' - default: - description: Default error handling for unmentioned status codes - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V1.0RC03#/components/schemas/Result' - /submodels/{submodelIdentifier}/submodel-elements/{idShortPath}/attachment: - get: - tags: - - Asset Administration Shell Environment API - summary: Downloads file content from a specific submodel element from the Submodel at a specified path - operationId: GetFileByPath_SubmodelRepo - x-semanticIds: - - https://admin-shell.io/aas/API/GetFileByPath/1/0/RC03 - parameters: - - name: submodelIdentifier - in: path - description: The Submodel’s unique id (UTF8-BASE64-URL-encoded) - required: true - style: simple - explode: false - schema: - type: string - format: byte - - name: idShortPath - in: path - description: IdShort path to the submodel element (dot-separated) - required: true - style: simple - explode: false - schema: - type: string - responses: - '200': - description: Requested file - headers: - Content-Disposition: - schema: - type: string - description: In order to physically download the file usually set to attachment with a filename - example: 'attachment; filename="filename.jpg"' - content: - application/octet-stream: - schema: - type: string - format: binary - '404': - description: Not Found - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V1.0RC03#/components/schemas/Result' - '405': - description: Method not allowed - Download only valid for File submodel element - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V1.0RC03#/components/schemas/Result' - default: - description: Default error handling for unmentioned status codes - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V1.0RC03#/components/schemas/Result' - put: - tags: - - Asset Administration Shell Environment API - summary: Uploads file content to an existing submodel element at a specified path within submodel elements hierarchy - operationId: PutFileByPath_SubmodelRepo - x-semanticIds: - - https://admin-shell.io/aas/API/PutFileByPath/1/0/RC03 - parameters: - - name: submodelIdentifier - in: path - description: The Submodel’s unique id (UTF8-BASE64-URL-encoded) - required: true - style: simple - explode: false - schema: - type: string - format: byte - - name: idShortPath - in: path - description: IdShort path to the submodel element (dot-separated) - required: true - style: simple - explode: false - schema: - type: string - requestBody: - description: File to upload - content: - multipart/form-data: - schema: - type: object - properties: - fileName: - type: string - file: - type: string - format: binary - encoding: - file: - contentType: application/octet-stream - required: true - responses: - '204': - description: Submodel element updated successfully - '400': - description: Bad Request - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V1.0RC03#/components/schemas/Result' - '404': - description: Not Found - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V1.0RC03#/components/schemas/Result' - '405': - description: Method not allowed - Upload only valid for File submodel element - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V1.0RC03#/components/schemas/Result' - default: - description: Default error handling for unmentioned status codes - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V1.0RC03#/components/schemas/Result' - /submodels/{submodelIdentifier}/submodel-elements/{idShortPath}/invoke: - post: - tags: - - Asset Administration Shell Environment API - summary: Synchronously or asynchronously invokes an Operation at a specified path - operationId: InvokeOperation_SubmodelRepo - x-semanticIds: - - https://admin-shell.io/aas/API/InvokeOperationSync/1/0/RC03 - - https://admin-shell.io/aas/API/InvokeOperationAsync/1/0/RC03 - parameters: - - name: async - in: query - description: Determines whether an operation invocation is performed asynchronously or synchronously - schema: - type: boolean - default: false - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V1.0RC03#/components/parameters/Content' - - name: submodelIdentifier - in: path - description: The Submodel’s unique id (UTF8-BASE64-URL-encoded) - required: true - style: simple - explode: false - schema: - type: string - format: byte - - name: idShortPath - in: path - description: IdShort path to the submodel element (dot-separated), in this case an operation - required: true - style: simple - explode: false - schema: - type: string - requestBody: - description: Operation request object - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V1.0RC03#/components/schemas/OperationRequest' - required: true - responses: - '200': - description: Operation result object - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V1.0RC03#/components/schemas/OperationResult' - '400': - description: Bad Request - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V1.0RC03#/components/schemas/Result' - '404': - description: Not Found - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V1.0RC03#/components/schemas/Result' - '405': - description: Method not allowed - Invoke only valid for Operation submodel element - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V1.0RC03#/components/schemas/Result' - default: - description: Default error handling for unmentioned status codes - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V1.0RC03#/components/schemas/Result' - /submodels/{submodelIdentifier}/submodel-elements/{idShortPath}/operation-results/{handleId}: - get: - tags: - - Asset Administration Shell Environment API - summary: Returns the Operation result of an asynchronous invoked Operation - operationId: GetOperationAsyncResult_SubmodelRepo - x-semanticIds: - - https://admin-shell.io/aas/API/GetOperationAsyncResult/1/0/RC03 - parameters: - - name: content - in: query - schema: - type: string - default: normal - enum: - - normal - - value - - name: submodelIdentifier - in: path - description: The Submodel’s unique id (UTF8-BASE64-URL-encoded) - required: true - style: simple - explode: false - schema: - type: string - format: byte - - name: idShortPath - in: path - description: IdShort path to the submodel element (dot-separated), in this case an operation - required: true - style: simple - explode: false - schema: - type: string - - name: handleId - in: path - description: The returned handle id of an operation’s asynchronous invocation used to request the current state of the operation’s execution (UTF8-BASE64-URL-encoded) - required: true - style: simple - explode: false - schema: - type: string - format: byte - responses: - '200': - description: Operation result object - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V1.0RC03#/components/schemas/OperationResult' - '404': - description: Not Found - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V1.0RC03#/components/schemas/Result' - default: - description: Default error handling for unmentioned status codes - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V1.0RC03#/components/schemas/Result' - /concept-descriptions: - get: - tags: - - Asset Administration Shell Environment API - summary: Returns all Concept Descriptions - operationId: GetAllConceptDescriptions - x-semanticIds: - - https://admin-shell.io/aas/API/GetAllConceptDescriptions/1/0/RC03 - - https://admin-shell.io/aas/API/GetAllConceptDescriptionsByIdShort/1/0/RC03 - - https://admin-shell.io/aas/API/GetAllConceptDescriptionsByIsCaseOf/1/0/RC03 - - https://admin-shell.io/aas/API/GetAllConceptDescriptionsByDataSpecificationReference/1/0/RC03 - parameters: - - name: idShort - in: query - description: The Concept Description’s IdShort - required: false - style: form - explode: true - schema: - type: string - - name: isCaseOf - in: query - description: IsCaseOf reference (UTF8-BASE64-URL-encoded) - required: false - style: form - explode: true - schema: - type: string - format: byte - - name: dataSpecificationRef - in: query - description: DataSpecification reference (UTF8-BASE64-URL-encoded) - required: false - style: form - explode: true - schema: - type: string - format: byte - responses: - '200': - description: Requested Concept Descriptions - content: - application/json: - schema: - type: array - items: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0RC02#/components/schemas/ConceptDescription' - default: - description: Default error handling for unmentioned status codes - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V1.0RC03#/components/schemas/Result' - post: - tags: - - Asset Administration Shell Environment API - summary: Creates a new Concept Description - operationId: PostConceptDescription - x-semanticIds: - - https://admin-shell.io/aas/API/PostConceptDescription/1/0/RC03 - requestBody: - description: Concept Description object - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0RC02#/components/schemas/ConceptDescription' - required: true - responses: - '201': - description: Concept Description created successfully - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0RC02#/components/schemas/ConceptDescription' - '400': - description: Bad Request - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V1.0RC03#/components/schemas/Result' - default: - description: Default error handling for unmentioned status codes - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V1.0RC03#/components/schemas/Result' - /concept-descriptions/{cdIdentifier}: - get: - tags: - - Asset Administration Shell Environment API - summary: Returns a specific Concept Description - operationId: GetConceptDescriptionById - x-semanticIds: - - https://admin-shell.io/aas/API/GetConceptDescriptionById/1/0/RC03 - parameters: - - name: cdIdentifier - in: path - description: The Concept Description’s unique id (UTF8-BASE64-URL-encoded) - required: true - style: simple - explode: true - schema: - type: string - format: byte - responses: - '200': - description: Requested Concept Description - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0RC02#/components/schemas/ConceptDescription' - '404': - description: Not Found - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V1.0RC03#/components/schemas/Result' - default: - description: Default error handling for unmentioned status codes - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V1.0RC03#/components/schemas/Result' - put: - tags: - - Asset Administration Shell Environment API - summary: Updates an existing Concept Description - operationId: PutConceptDescriptionById - x-semanticIds: - - https://admin-shell.io/aas/API/PutConceptDescriptionById/1/0/RC03 - parameters: - - name: cdIdentifier - in: path - description: The Concept Description’s unique id (UTF8-BASE64-URL-encoded) - required: true - style: simple - explode: false - schema: - type: string - format: byte - requestBody: - description: Concept Description object - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0RC02#/components/schemas/ConceptDescription' - required: true - responses: - '204': - description: Concept Description updated successfully - '400': - description: Bad Request - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V1.0RC03#/components/schemas/Result' - '404': - description: Not Found - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V1.0RC03#/components/schemas/Result' - default: - description: Default error handling for unmentioned status codes - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V1.0RC03#/components/schemas/Result' - delete: - tags: - - Asset Administration Shell Environment API - summary: Deletes a Concept Description - operationId: DeleteConceptDescriptionById - x-semanticIds: - - https://admin-shell.io/aas/API/DeleteConceptDescriptionById/1/0/RC03 - parameters: - - name: cdIdentifier - in: path - description: The Concept Description’s unique id (UTF8-BASE64-URL-encoded) - required: true - style: simple - explode: false - schema: - type: string - format: byte - responses: - '204': - description: Concept Description deleted successfully - '404': - description: Not Found - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V1.0RC03#/components/schemas/Result' - default: - description: Default error handling for unmentioned status codes - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V1.0RC03#/components/schemas/Result' - /serialization: - get: - tags: - - Asset Administration Shell Environment Serialization API - summary: Returns an appropriate serialization based on the specified format (see SerializationFormat) - operationId: GenerateSerializationByIds - x-semanticIds: - - https://admin-shell.io/aas/API/GenerateSerializationByIds/1/0/RC03 - parameters: - - name: aasIds - in: query - description: The Asset Administration Shells' unique ids (UTF8-BASE64-URL-encoded) - required: true - style: form - explode: true - schema: - type: array - items: - type: string - - name: submodelIds - in: query - description: The Submodels' unique ids (UTF8-BASE64-URL-encoded) - required: true - style: form - explode: true - schema: - type: array - items: - type: string - - name: includeConceptDescriptions - in: query - description: Include Concept Descriptions? - required: true - style: form - explode: true - schema: - type: boolean - default: true - responses: - '200': - description: Requested serialization based on SerializationFormat - content: - application/asset-administration-shell-package+xml: - schema: - description: AASX package - type: string - format: binary - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0RC02#/components/schemas/Environment' - application/xml: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0RC02#/components/schemas/Environment' - default: - description: Default error handling for unmentioned status codes - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V1.0RC03#/components/schemas/Result' \ No newline at end of file diff --git a/AssetAdministrationShellRepositoryServiceSpecification/V3.0-MinimalProfile.yaml b/AssetAdministrationShellRepositoryServiceSpecification/V3.0-MinimalProfile.yaml deleted file mode 100644 index 8ba3379a..00000000 --- a/AssetAdministrationShellRepositoryServiceSpecification/V3.0-MinimalProfile.yaml +++ /dev/null @@ -1,394 +0,0 @@ -openapi: 3.0.3 -info: - title: DotAAS Part 2 | HTTP/REST | Repository Service Specification - Basic Profile - description: The Basic Profile of the Repository Service Specification as part of Details of the Asset Administration Shell Part 2 - contact: - name: Constantin Ziesche, Andreas Orzelski, Florian Krebs, Bastian Rössl, Manuel Sauer, Jens Vialkowitsch, Michael Hoffmeister, Torben Miny, Sebastian Bader, Marko Ristin, Nico Braunisch - version: V3.0-MinimalProfile - termsOfService: https://github.com/admin-shell-io/aas-specs -servers: -- url: '{protocol}://{host_name}:{port}/api/{version_prefix}' - variables: - protocol: - description: 'Allows access through http and https (recommended)' - enum: - - 'http' - - 'https' - default: 'https' - host_name: - default: admin-shell.io - description: 'Hostname of server hosting the api' - port: - enum: - - '80' - - '443' - default: '443' - description: '80 is default for http, 443 for https' - version_prefix: - enum: - - 'v3.0' - default: v3.0 -paths: - /shells: - get: - tags: - - Asset Administration Shell Repository API - summary: Returns all Asset Administration Shells - operationId: GetAllAssetAdministrationShells - x-semanticIds: - - https://admin-shell.io/aas/API/GetAllAssetAdministrationShells/3/0 - - https://admin-shell.io/aas/API/GetAllAssetAdministrationShellsByAssetId/3/0 - - https://admin-shell.io/aas/API/GetAllAssetAdministrationShellsByIdShort/3/0 - parameters: - - name: assetIds - in: query - description: A list of specific Asset identifiers - required: false - style: form - explode: true - schema: - type: array - items: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0#/components/schemas/SpecificAssetId' - example: '[ { "name": "some-asset-id", "value": "http://example-company.com/myAsset", "externalSubjectId": { "keys": [ { "type": "GlobalReference", "value": "http://example-company.com/example-companys-asset-keys" } ], "type": "GlobalReference" } }, { "name": "some-other-asset-id", "value": "12345ABC", "externalSubjectId": { "keys": [ { "type": "GlobalReference", "value": "http://my-own-company.com/keys" } ], "type": "GlobalReference" } } ]e": "globalAssetId","value": "http://example.company/myAsset", "externalSubjectId": "http://example.company"},{"name": "myOwnInternalAssetId","value": "12345ABC", "externalSubjectId": "http://example.company"}]' - - name: idShort - in: query - description: The Asset Administration Shell’s IdShort - required: false - style: form - explode: true - schema: - type: string - responses: - '200': - description: Requested Asset Administration Shells - content: - application/json: - schema: - type: array - items: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0#/components/schemas/AssetAdministrationShell' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - post: - tags: - - Asset Administration Shell Repository API - summary: Creates a new Asset Administration Shell - operationId: PostAssetAdministrationShell - x-semanticIds: - - https://admin-shell.io/aas/API/PostAssetAdministrationShell/3/0 - requestBody: - description: Asset Administration Shell object - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0#/components/schemas/AssetAdministrationShell' - required: true - responses: - '201': - description: Asset Administration Shell created successfully - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0#/components/schemas/AssetAdministrationShell' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '409': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/conflict' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /shells/{aasIdentifier}: - get: - tags: - - Asset Administration Shell Repository API - summary: Returns a specific Asset Administration Shell - operationId: GetAssetAdministrationShellById - x-semanticIds: - - https://admin-shell.io/aas/API/GetAssetAdministrationShellById/3/0 - parameters: - - name: aasIdentifier - in: path - description: The Asset Administration Shell’s unique id (UTF8-BASE64-URL-encoded) - required: true - style: simple - explode: false - schema: - type: string - format: byte - responses: - '200': - description: Requested Asset Administration Shell - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0#/components/schemas/AssetAdministrationShell' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - put: - tags: - - Asset Administration Shell Repository API - summary: Updates an existing Asset Administration Shell - operationId: PutAssetAdministrationShellById - x-semanticIds: - - https://admin-shell.io/aas/API/PutAssetAdministrationShellById/3/0 - parameters: - - name: aasIdentifier - in: path - description: The Asset Administration Shell’s unique id (UTF8-BASE64-URL-encoded) - required: true - style: simple - explode: false - schema: - type: string - format: byte - requestBody: - description: Asset Administration Shell object - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0#/components/schemas/AssetAdministrationShell' - required: true - responses: - '204': - description: Asset Administration Shell updated successfully - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - delete: - tags: - - Asset Administration Shell Repository API - summary: Deletes an Asset Administration Shell - operationId: DeleteAssetAdministrationShellById - x-semanticIds: - - https://admin-shell.io/aas/API/DeleteAssetAdministrationShellById/3/0 - parameters: - - name: aasIdentifier - in: path - description: The Asset Administration Shell’s unique id (UTF8-BASE64-URL-encoded) - required: true - style: simple - explode: false - schema: - type: string - format: byte - responses: - '204': - description: Asset Administration Shell deleted successfully - '404': - description: Not Found - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/Result' - default: - description: Default error handling for unmentioned status codes - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/Result' - /shells/{aasIdentifier}/submodels: - get: - tags: - - Asset Administration Shell Repository API - summary: Returns all submodel references - operationId: GetAllSubmodelReferences - x-semanticIds: - - https://admin-shell.io/aas/API/GetAllSubmodelReferences/3/0 - parameters: - - name: aasIdentifier - in: path - description: The Asset Administration Shell’s unique id (UTF8-BASE64-URL-encoded) - required: true - style: simple - explode: false - schema: - type: string - format: byte - responses: - '200': - description: Requested submodel references - content: - application/json: - schema: - type: array - items: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0#/components/schemas/Reference' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - post: - tags: - - Asset Administration Shell Repository API - summary: Creates a submodel reference at the Asset Administration Shell - operationId: PostSubmodelReference - x-semanticIds: - - https://admin-shell.io/aas/API/PostSubmodelReference/3/0 - parameters: - - name: aasIdentifier - in: path - description: The Asset Administration Shell’s unique id (UTF8-BASE64-URL-encoded) - required: true - style: simple - explode: false - schema: - type: string - format: byte - requestBody: - description: Reference to the Submodel - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0#/components/schemas/Reference' - required: true - responses: - '201': - description: Submodel reference created successfully - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0#/components/schemas/Reference' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '409': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/conflict' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /shells/{aasIdentifier}/submodels/{submodelIdentifier}: - get: - tags: - - Asset Administration Shell Repository API - summary: Returns the Submodel - operationId: GetSubmodelById - x-semanticIds: - - https://admin-shell.io/aas/API/GetSubmodelById/3/0 - parameters: - - name: aasIdentifier - in: path - description: The Asset Administration Shell’s unique id (UTF8-BASE64-URL-encoded) - required: true - style: simple - explode: false - schema: - type: string - format: byte - - name: submodelIdentifier - in: path - description: The Submodel’s unique id (UTF8-BASE64-URL-encoded) - required: true - style: simple - explode: false - schema: - type: string - format: byte - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Extent' - responses: - '200': - description: Requested Submodel - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0#/components/schemas/Submodel' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - delete: - tags: - - Asset Administration Shell Repository API - summary: Deletes the submodel reference from the Asset Administration Shell. Does not delete the submodel itself! - operationId: DeleteSubmodelReferenceById - x-semanticIds: - - https://admin-shell.io/aas/API/DeleteSubmodelReference/3/0 - parameters: - - name: aasIdentifier - in: path - description: The Asset Administration Shell’s unique id (UTF8-BASE64-URL-encoded) - required: true - style: simple - explode: false - schema: - type: string - format: byte - - name: submodelIdentifier - in: path - description: The Submodel’s unique id (UTF8-BASE64-URL-encoded) - required: true - style: simple - explode: false - schema: - type: string - format: byte - responses: - '204': - description: Submodel reference deleted successfully - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /description: - get: - tags: - - Description API - summary: Returns the self-describing information of a network resource (ServiceDescription) - operationId: GetDescription - x-semanticIds: - - https://admin-shell.io/aas/API/Descriptor/GetDescription/3/0 - responses: - '200': - description: Requested Description - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/ServiceDescription' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' \ No newline at end of file diff --git a/AssetAdministrationShellRepositoryServiceSpecification/V3.0.yaml b/AssetAdministrationShellRepositoryServiceSpecification/V3.0.yaml deleted file mode 100644 index 9e29825c..00000000 --- a/AssetAdministrationShellRepositoryServiceSpecification/V3.0.yaml +++ /dev/null @@ -1,1631 +0,0 @@ -openapi: 3.0.3 -info: - title: DotAAS Part 2 | HTTP/REST | Asset Administration Shell Repository Service Specification - description: "The Asset Administration Shell Repository Service Specification as part of Details of the Asset Administration Shell Part 2 - Copyright: Industrial Digital Twin Association (IDTA) 2023" - contact: - name: Industrial Digital Twin Association (IDTA) - email: info@idtwin.org - license: - name: CC BY-SA 4.0 - url: https://creativecommons.org/licenses/by-sa/4.0/ - version: V3.0 - termsOfService: https://github.com/admin-shell-io/aas-specs -servers: -- url: '{protocol}://{host_name}:{port}/api/{version_prefix}' - variables: - protocol: - description: 'Allows access through http and https (recommended)' - enum: - - 'http' - - 'https' - default: 'https' - host_name: - default: admin-shell.io - description: 'Hostname of server hosting the api' - port: - enum: - - '80' - - '443' - default: '443' - description: '80 is default for http, 443 for https' - version_prefix: - enum: - - 'v3.0' - default: v3.0 -paths: - /shells: - get: - tags: - - Asset Administration Shell Repository API - summary: Returns all Asset Administration Shells - operationId: GetAllAssetAdministrationShells - x-semanticIds: - - https://admin-shell.io/aas/API/GetAllAssetAdministrationShells/3/0 - - https://admin-shell.io/aas/API/GetAllAssetAdministrationShellsByAssetId/3/0 - - https://admin-shell.io/aas/API/GetAllAssetAdministrationShellsByIdShort/3/0 - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Limit' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Cursor' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/IdShort' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/AssetIds' - responses: - '200': - description: Requested Asset Administration Shells - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/GetAssetAdministrationShellsResult' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - post: - tags: - - Asset Administration Shell Repository API - summary: Creates a new Asset Administration Shell - operationId: PostAssetAdministrationShell - x-semanticIds: - - https://admin-shell.io/aas/API/PostAssetAdministrationShell/3/0 - requestBody: - description: Asset Administration Shell object - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0#/components/schemas/AssetAdministrationShell' - required: true - responses: - '201': - description: Asset Administration Shell created successfully - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0#/components/schemas/AssetAdministrationShell' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '409': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/conflict' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - '/shells/$reference': - get: - tags: - - Asset Administration Shell Repository API - summary: Returns References to all Asset Administration Shells - operationId: GetAllAssetAdministrationShells-Reference - x-semanticIds: - - https://admin-shell.io/aas/API/GetAllAssetAdministrationShells/3/0 - - https://admin-shell.io/aas/API/GetAllAssetAdministrationShellsByAssetId/3/0 - - https://admin-shell.io/aas/API/GetAllAssetAdministrationShellsByIdShort/3/0 - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Limit' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Cursor' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/IdShort' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/AssetIds' - responses: - '200': - description: Requested Asset Administration Shells as a list of References - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/GetReferencesResult' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /shells/{aasIdentifier}: - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/AssetAdministrationShellIdentifier' - get: - tags: - - Asset Administration Shell Repository API - summary: Returns a specific Asset Administration Shell - operationId: GetAssetAdministrationShellById - x-semanticIds: - - https://admin-shell.io/aas/API/GetAssetAdministrationShellById/3/0 - responses: - '200': - description: Requested Asset Administration Shell - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0#/components/schemas/AssetAdministrationShell' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - put: - tags: - - Asset Administration Shell Repository API - summary: Updates an existing Asset Administration Shell - operationId: PutAssetAdministrationShellById - x-semanticIds: - - https://admin-shell.io/aas/API/PutAssetAdministrationShellById/3/0 - requestBody: - description: Asset Administration Shell object - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0#/components/schemas/AssetAdministrationShell' - required: true - responses: - '204': - description: Asset Administration Shell updated successfully - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - delete: - tags: - - Asset Administration Shell Repository API - summary: Deletes an Asset Administration Shell - operationId: DeleteAssetAdministrationShellById - x-semanticIds: - - https://admin-shell.io/aas/API/DeleteAssetAdministrationShellById/3/0 - responses: - '204': - description: Asset Administration Shell deleted successfully - '404': - description: Not Found - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/Result' - default: - description: Default error handling for unmentioned status codes - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/Result' - /shells/{aasIdentifier}/$reference: - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/AssetAdministrationShellIdentifier' - get: - tags: - - Asset Administration Shell Repository API - summary: Returns a specific Asset Administration Shell as a Reference - operationId: GetAssetAdministrationShellById-Reference - x-semanticIds: - - https://admin-shell.io/aas/API/GetAssetAdministrationShellById/3/0 - responses: - '200': - description: Requested Asset Administration Shell - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0#/components/schemas/Reference' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /shells/{aasIdentifier}/asset-information: - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/AssetAdministrationShellIdentifier' - get: - tags: - - Asset Administration Shell Repository API - summary: Returns the Asset Information - operationId: GetAssetInformation - x-semanticIds: - - https://admin-shell.io/aas/API/GetAssetInformation/3/0 - responses: - '200': - description: Requested Asset Information - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0#/components/schemas/AssetInformation' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - put: - tags: - - Asset Administration Shell Repository API - summary: Updates the Asset Information - operationId: PutAssetInformation - x-semanticIds: - - https://admin-shell.io/aas/API/PutAssetInformation/3/0 - requestBody: - description: Asset Information object - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0#/components/schemas/AssetInformation' - required: true - responses: - '204': - description: Asset Information updated successfully - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - - /shells/{aasIdentifier}/asset-information/thumbnail: - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/AssetAdministrationShellIdentifier' - get: - tags: - - Asset Administration Shell Repository API - responses: - '200': - description: The thumbnail of the Asset Information. - content: - application/octet-stream: - schema: - type: string - format: binary - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - put: - tags: - - Asset Administration Shell Repository API - requestBody: - description: Thumbnail to upload - content: - multipart/form-data: - schema: - type: object - properties: - fileName: - type: string - file: - type: string - format: binary - encoding: - file: - contentType: application/octet-stream - required: true - responses: - '204': - description: Thumbnail updated successfully - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - delete: - tags: - - Asset Administration Shell Repository API - operationId: DeleteThumbnail - x-semanticIds: - - https://admin-shell.io/aas/API/DeleteThumbnail/3/0 - responses: - '200': - description: Thumbnail deletion successful - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /shells/{aasIdentifier}/submodels: - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/AssetAdministrationShellIdentifier' - get: - tags: - - Asset Administration Shell Repository API - summary: Returns all submodel references - operationId: GetAllSubmodels-Reference - x-semanticIds: - - https://admin-shell.io/aas/API/GetAllSubmodels/3/0 - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Limit' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Cursor' - responses: - '200': - description: Requested submodel references - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/GetReferencesResult' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - post: - tags: - - Asset Administration Shell Repository API - summary: Creates a submodel reference at the Asset Administration Shell - operationId: PostSubmodelReference - x-semanticIds: - - https://admin-shell.io/aas/API/PostSubmodelReference/3/0 - requestBody: - description: Reference to the Submodel - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0#/components/schemas/Reference' - required: true - responses: - '201': - description: Submodel reference created successfully - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0#/components/schemas/Reference' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '409': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/conflict' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /shells/{aasIdentifier}/submodels/{submodelIdentifier}: - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/SubmodelIdentifier' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/AssetAdministrationShellIdentifier' - delete: - tags: - - Asset Administration Shell Repository API - summary: Deletes the submodel reference from the Asset Administration Shell. Does not delete the submodel itself! - operationId: DeleteSubmodelReferenceById - x-semanticIds: - - https://admin-shell.io/aas/API/DeleteSubmodelReference/3/0 - responses: - '204': - description: Submodel reference deleted successfully - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - get: - tags: - - Asset Administration Shell Repository API - summary: Returns the Submodel - operationId: GetSubmodelById - x-semanticIds: - - https://admin-shell.io/aas/API/GetSubmodelById/3/0 - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Level' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Extent' - responses: - '200': - description: Requested Submodel - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0#/components/schemas/Submodel' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - put: - tags: - - Asset Administration Shell Repository API - summary: Updates the Submodel - operationId: PutSubmodel - x-semanticIds: - - https://admin-shell.io/aas/API/PutSubmodel/3/0 - parameters: - #- $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Level' - - name: level - in: query - description: Determines the structural depth of the respective resource content - required: false - schema: - type: string - default: deep - enum: - - deep # only 'deep' is allowed for PUT - #- core - requestBody: - description: Submodel object - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0#/components/schemas/Submodel' - required: true - responses: - '204': - description: Submodel updated successfully - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - patch: - tags: - - Asset Administration Shell Repository API - summary: Updates the Submodel - operationId: PatchSubmodel - x-semanticIds: - - https://admin-shell.io/aas/API/PutSubmodel/3/0 - parameters: - #- $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Level' - - name: level - in: query - description: Determines the structural depth of the respective resource content - required: false - schema: - type: string - default: core - enum: - #- deep - - core # only 'deep' is allowed for PUT - requestBody: - description: Submodel object - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0#/components/schemas/Submodel' - required: true - responses: - '204': - description: Submodel updated successfully - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /shells/{aasIdentifier}/submodels/{submodelIdentifier}/$metadata: - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/SubmodelIdentifier' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/AssetAdministrationShellIdentifier' - get: - tags: - - Asset Administration Shell Repository API - summary: Returns the Submodel's metadata elements - operationId: GetSubmodel-Metadata - x-semanticIds: - - https://admin-shell.io/aas/API/GetSubmodel/3/0 - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Level' - responses: - '200': - description: Requested Submodel - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/SubmodelMetadata' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - patch: - tags: - - Asset Administration Shell Repository API - summary: Updates the metadata attributes of the Submodel - operationId: PatchSubmodel-Metadata - x-semanticIds: - - https://admin-shell.io/aas/API/PutSubmodel/3/0 - parameters: - #- $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Level' - - name: level - in: query - description: Determines the structural depth of the respective resource content - required: false - schema: - type: string - default: core - enum: - #- deep - - core # only 'deep' is allowed for PUT - requestBody: - description: Submodel object - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/SubmodelMetadata' - required: true - responses: - '204': - description: Submodel updated successfully - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /shells/{aasIdentifier}/submodels/{submodelIdentifier}/$value: - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/SubmodelIdentifier' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/AssetAdministrationShellIdentifier' - get: - tags: - - Asset Administration Shell Repository API - summary: Returns the Submodel's ValueOnly representation - operationId: GetSubmodel-ValueOnly - x-semanticIds: - - https://admin-shell.io/aas/API/GetSubmodel/3/0 - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Level' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Extent' - responses: - '200': - description: Requested Submodel - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/SubmodelValue' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - patch: - tags: - - Asset Administration Shell Repository API - summary: Updates teh values of the Submodel - operationId: PatchSubmodel-ValueOnly - x-semanticIds: - - https://admin-shell.io/aas/API/PutSubmodel/3/0 - parameters: - #- $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Level' - - name: level - in: query - description: Determines the structural depth of the respective resource content - required: false - schema: - type: string - default: core - enum: - #- deep - - core # only 'deep' is allowed for PUT - requestBody: - description: Submodel object in the ValueOnly representation - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/SubmodelValue' - required: true - responses: - '204': - description: Submodel updated successfully - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /shells/{aasIdentifier}/submodels/{submodelIdentifier}/$reference: - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/SubmodelIdentifier' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/AssetAdministrationShellIdentifier' - get: - tags: - - Asset Administration Shell Repository API - summary: Returns the Submodel as a Reference - operationId: GetSubmodelMetadata-Reference - x-semanticIds: - - https://admin-shell.io/aas/API/GetSubmodel/3/0 - parameters: - #- $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Level' - - name: level - in: query - description: Determines the structural depth of the respective resource content - required: false - schema: - type: string - default: core - enum: - # - deep - - core # only 'core' is allowed for Content=Reference - responses: - '200': - description: Requested Submodel as a Reference - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0#/components/schemas/Reference' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - - /shells/{aasIdentifier}/submodels/{submodelIdentifier}/$path: - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/SubmodelIdentifier' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/AssetAdministrationShellIdentifier' - get: - tags: - - Asset Administration Shell Repository API - summary: Returns the Submodel's metadata elements - operationId: GetSubmodel-Path - x-semanticIds: - - https://admin-shell.io/aas/API/GetSubmodel/3/0 - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Level' - responses: - '200': - description: Requested Submodel in Path notation - content: - application/json: - schema: - type: array - items: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/PathItem' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /shells/{aasIdentifier}/submodels/{submodelIdentifier}/submodel-elements: - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/SubmodelIdentifier' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/AssetAdministrationShellIdentifier' - get: - tags: - - Asset Administration Shell Repository API - summary: Returns all submodel elements including their hierarchy - operationId: GetAllSubmodelElements - x-semanticIds: - - https://admin-shell.io/aas/API/GetAllSubmodelElements/3/0 - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Limit' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Cursor' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Level' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Extent' - responses: - '200': - description: List of found submodel elements - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/GetSubmodelElementsResult' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - post: - tags: - - Asset Administration Shell Repository API - summary: Creates a new submodel element - operationId: PostSubmodelElement - x-semanticIds: - - https://admin-shell.io/aas/API/PostSubmodelElement/3/0 - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Level' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Extent' - requestBody: - description: Requested submodel element - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0#/components/schemas/SubmodelElement' - required: true - responses: - '201': - description: Submodel element created successfully - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0#/components/schemas/SubmodelElement' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '409': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/conflict' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /shells/{aasIdentifier}/submodels/{submodelIdentifier}/submodel-elements/$metadata: - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/SubmodelIdentifier' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/AssetAdministrationShellIdentifier' - get: - tags: - - Asset Administration Shell Repository API - summary: Returns all submodel elements including their hierarchy - operationId: GetAllSubmodelElements-Metadata - x-semanticIds: - - https://admin-shell.io/aas/API/GetAllSubmodelElements/3/0 - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Limit' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Cursor' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Level' - responses: - '200': - description: List of found submodel elements - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/GetSubmodelElementsMetadataResult' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /shells/{aasIdentifier}/submodels/{submodelIdentifier}/submodel-elements/$value: - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/SubmodelIdentifier' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/AssetAdministrationShellIdentifier' - get: - tags: - - Asset Administration Shell Repository API - summary: Returns all submodel elements including their hierarchy in the ValueOnly representation - operationId: GetAllSubmodelElements-ValueOnly - x-semanticIds: - - https://admin-shell.io/aas/API/GetAllSubmodelElements/3/0 - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Limit' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Cursor' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Level' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Extent' - responses: - '200': - description: List of found submodel elements in their ValueOnly representation - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/GetSubmodelElementsValueResult' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /shells/{aasIdentifier}/submodels/{submodelIdentifier}/submodel-elements/$reference: - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/SubmodelIdentifier' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/AssetAdministrationShellIdentifier' - get: - tags: - - Asset Administration Shell Repository API - summary: Returns all submodel elements as a list of References - operationId: GetAllSubmodelElements-Reference - x-semanticIds: - - https://admin-shell.io/aas/API/GetAllSubmodelElements/3/0 - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Limit' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Cursor' - #- $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Level' - - name: level - in: query - description: Determines the structural depth of the respective resource content - required: false - schema: - type: string - default: core - enum: - # - deep - - core # only 'core' is allowed for Content=Reference - responses: - '200': - description: List of References of the found submodel elements - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/GetReferencesResult' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /shells/{aasIdentifier}/submodels/{submodelIdentifier}/submodel-elements/$path: - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/SubmodelIdentifier' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/AssetAdministrationShellIdentifier' - get: - tags: - - Asset Administration Shell Repository API - summary: Returns all submodel elements including their hierarchy - operationId: GetAllSubmodelElements-Path - x-semanticIds: - - https://admin-shell.io/aas/API/GetAllSubmodelElements/3/0 - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Limit' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Cursor' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Level' - responses: - '200': - description: List of found submodel elements in the Path notation - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/GetPathItemsResult' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /shells/{aasIdentifier}/submodels/{submodelIdentifier}/submodel-elements/{idShortPath}: - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/SubmodelIdentifier' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/AssetAdministrationShellIdentifier' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/IdShortPath' - get: - tags: - - Asset Administration Shell Repository API - summary: Returns a specific submodel element from the Submodel at a specified - path - operationId: GetSubmodelElementByPath - x-semanticIds: - - https://admin-shell.io/aas/API/GetSubmodelElementByPath/3/0 - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Limit' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Cursor' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Level' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Extent' - responses: - '200': - description: Requested submodel element - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/GetSubmodelElementsResult' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - post: - tags: - - Asset Administration Shell Repository API - summary: Creates a new submodel element at a specified path within submodel elements hierarchy - operationId: PostSubmodelElementByPath - x-semanticIds: - - https://admin-shell.io/aas/API/PostSubmodelElementByPath/3/0 - requestBody: - description: Requested submodel element - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0#/components/schemas/SubmodelElement' - required: true - responses: - '201': - description: Submodel element created successfully - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0#/components/schemas/SubmodelElement' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '409': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/conflict' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - put: - tags: - - Asset Administration Shell Repository API - summary: Updates an existing submodel element at a specified path within submodel elements hierarchy - operationId: PutSubmodelElementByPath - x-semanticIds: - - https://admin-shell.io/aas/API/PutSubmodelElementByPath/3/0 - - https://admin-shell.io/aas/API/SetSubmodelElementValueByPath/3/0 - requestBody: - description: Requested submodel element - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0#/components/schemas/SubmodelElement' - required: true - responses: - '204': - description: Submodel element updated successfully - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - patch: - tags: - - Asset Administration Shell Repository API - summary: Updates an existing submodel element value at a specified path within submodel elements hierarchy - operationId: PatchSubmodelElementValueByPath - x-semanticIds: - - https://admin-shell.io/aas/API/PatchSubmodelElementByPath/3/0 - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Level' - requestBody: - description: The updated value of the submodel element - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0#/components/schemas/SubmodelElement' - required: true - responses: - '204': - description: Submodel element updated successfully - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - delete: - tags: - - Asset Administration Shell Repository API - summary: Deletes a submodel element at a specified path within the submodel elements hierarchy - operationId: DeleteSubmodelElementByPath - x-semanticIds: - - https://admin-shell.io/aas/API/DeleteSubmodelElementByPath/3/0 - responses: - '204': - description: Submodel element deleted successfully - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /shells/{aasIdentifier}/submodels/{submodelIdentifier}/submodel-elements/{idShortPath}/$metadata: - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/SubmodelIdentifier' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/AssetAdministrationShellIdentifier' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/IdShortPath' - get: - tags: - - Asset Administration Shell Repository API - summary: Returns the metadata attributes if a specific submodel element from the Submodel at a specified - path - operationId: GetSubmodelElementByPath-Metadata - x-semanticIds: - - https://admin-shell.io/aas/API/GetSubmodelElementByPath/3/0 - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Limit' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Cursor' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Level' - responses: - '200': - description: Requested submodel element - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/GetSubmodelElementsMetadataResult' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - patch: - tags: - - Asset Administration Shell Repository API - summary: Updates the metadata attributes of an existing submodel element value at a specified path within submodel elements hierarchy - operationId: PatchSubmodelElementValueByPath-Metadata - x-semanticIds: - - https://admin-shell.io/aas/API/PatchSubmodelElementByPath/3/0 - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Level' - requestBody: - description: The updated metadata attributes of the submodel element - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/SubmodelElementMetadata' - required: true - responses: - '204': - description: Submodel element updated successfully - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /shells/{aasIdentifier}/submodels/{submodelIdentifier}/submodel-elements/{idShortPath}/$value: - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/SubmodelIdentifier' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/AssetAdministrationShellIdentifier' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/IdShortPath' - get: - tags: - - Asset Administration Shell Repository API - summary: Returns a specific submodel element from the Submodel at a specified - path in the ValueOnly representation - operationId: GetSubmodelElementByPath-ValueOnly - x-semanticIds: - - https://admin-shell.io/aas/API/GetSubmodelElementByPath/3/0 - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Limit' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Cursor' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Level' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Extent' - responses: - '200': - description: Requested submodel element in its ValueOnly representation - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/GetSubmodelElementsValueResult' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - patch: - tags: - - Asset Administration Shell Repository API - summary: Updates the value of an existing submodel element value at a specified path within submodel elements hierarchy - operationId: PatchSubmodelElementValueByPath-ValueOnly - x-semanticIds: - - https://admin-shell.io/aas/API/PatchSubmodelElementByPath/3/0 - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Level' - requestBody: - description: The updated value of the submodel element - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/SubmodelElementValue' - required: true - responses: - '204': - description: Submodel element updated successfully - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /shells/{aasIdentifier}/submodels/{submodelIdentifier}/submodel-elements/{idShortPath}/$reference: - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/SubmodelIdentifier' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/AssetAdministrationShellIdentifier' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/IdShortPath' - get: - tags: - - Asset Administration Shell Repository API - summary: Returns the Reference of a specific submodel element from the Submodel at a specified - path in the ValueOnly representation - operationId: GetSubmodelElementByPath-Reference - x-semanticIds: - - https://admin-shell.io/aas/API/GetSubmodelElementByPath/3/0 - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Limit' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Cursor' - #- $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Level' - - name: level - in: query - description: Determines the structural depth of the respective resource content - required: false - schema: - type: string - default: core - enum: - # - deep - - core # only 'core' is allowed for Content=Reference - responses: - '200': - description: Requested submodel element in its ValueOnly representation - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/GetReferencesResult' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /shells/{aasIdentifier}/submodels/{submodelIdentifier}/submodel-elements/{idShortPath}/$path: - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/SubmodelIdentifier' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/AssetAdministrationShellIdentifier' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/IdShortPath' - get: - tags: - - Asset Administration Shell Repository API - summary: Returns a specific submodel element from the Submodel at a specified path in the Path notation - operationId: GetSubmodelElementByPath-Path - x-semanticIds: - - https://admin-shell.io/aas/API/GetSubmodelElementByPath/3/0 - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Limit' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Cursor' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Level' - responses: - '200': - description: Requested submodel element in the Path notation - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/GetPathItemsResult' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /shells/{aasIdentifier}/submodels/{submodelIdentifier}/submodel-elements/{idShortPath}/attachment: - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/SubmodelIdentifier' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/AssetAdministrationShellIdentifier' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/IdShortPath' - get: - tags: - - Asset Administration Shell Repository API - summary: Downloads file content from a specific submodel element from the Submodel at a specified path - operationId: GetFileByPath - x-semanticIds: - - https://admin-shell.io/aas/API/GetFileByPath/3/0 - responses: - '200': - description: Requested file - headers: - Content-Disposition: - schema: - type: string - description: In order to physically download the file usually set to attachment with a filename - example: 'attachment; filename="filename.jpg"' - content: - application/octet-stream: - schema: - type: string - format: binary - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - put: - tags: - - Asset Administration Shell Repository API - summary: Uploads file content to an existing submodel element at a specified path within submodel elements hierarchy - operationId: PutFileByPath - x-semanticIds: - - https://admin-shell.io/aas/API/PutFileByPath/3/0 - requestBody: - description: File to upload - content: - multipart/form-data: - schema: - type: object - properties: - fileName: - type: string - file: - type: string - format: binary - encoding: - file: - contentType: application/octet-stream - required: true - responses: - '204': - description: Submodel element updated successfully - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - delete: - tags: - - Asset Administration Shell Repository API - summary: Deletes file content of an existing submodel element at a specified path within submodel elements hierarchy - operationId: DeleteFileByPath - x-semanticIds: - - https://admin-shell.io/aas/API/DeleteFileByPath/3/0 - responses: - '200': - description: Submodel element updated successfully - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /shells/{aasIdentifier}/submodels/{submodelIdentifier}/submodel-elements/{idShortPath}/invoke: - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/SubmodelIdentifier' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/AssetAdministrationShellIdentifier' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/IdShortPath' - post: - tags: - - Asset Administration Shell Repository API - summary: Synchronously or asynchronously invokes an Operation at a specified path - operationId: InvokeOperation - x-semanticIds: - - https://admin-shell.io/aas/API/InvokeOperationSync/3/0 - - https://admin-shell.io/aas/API/InvokeOperationAsync/3/0 - parameters: - - name: async - in: query - description: Determines whether an operation invocation is performed asynchronously or synchronously - schema: - type: boolean - default: false - requestBody: - description: Operation request object - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/OperationRequest' - required: true - responses: - '200': - description: Operation result object - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/OperationResult' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /shells/{aasIdentifier}/submodels/{submodelIdentifier}/submodel-elements/{idShortPath}/invoke/$value: - post: - tags: - - Asset Administration Shell Repository API - summary: Synchronously or asynchronously invokes an Operation at a specified path - operationId: InvokeOperation-ValueOnly - x-semanticIds: - - https://admin-shell.io/aas/API/InvokeOperationSync/3/0 - - https://admin-shell.io/aas/API/InvokeOperationAsync/3/0 - parameters: - - name: async - in: query - description: Determines whether an operation invocation is performed asynchronously or synchronously - schema: - type: boolean - default: false - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/AssetAdministrationShellIdentifier' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/SubmodelIdentifier' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/IdShortPath' - requestBody: - description: Operation request object - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/OperationRequestValueOnly' - required: true - responses: - '200': - description: Operation result object - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/OperationResultValueOnly' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /shells/{aasIdentifier}/submodels/{submodelIdentifier}/submodel-elements/{idShortPath}/operation-results/{handleId}: - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/SubmodelIdentifier' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/AssetAdministrationShellIdentifier' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/IdShortPath' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/HandleId' - get: - tags: - - Asset Administration Shell Repository API - summary: Returns the Operation result of an asynchronous invoked Operation - operationId: GetOperationAsyncResult - x-semanticIds: - - https://admin-shell.io/aas/API/GetOperationAsyncResult/3/0 - responses: - '200': - description: Operation result object - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/OperationResult' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - - /shells/{aasIdentifier}/submodels/{submodelIdentifier}/submodel-elements/{idShortPath}/operation-results/{handleId}/$value: - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/SubmodelIdentifier' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/AssetAdministrationShellIdentifier' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/IdShortPath' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/HandleId' - get: - tags: - - Asset Administration Shell Repository API - summary: Returns the value of the Operation result of an asynchronous invoked Operation - operationId: GetOperationAsyncResult-ValueOnly - x-semanticIds: - - https://admin-shell.io/aas/API/GetOperationAsyncResult/3/0 - responses: - '200': - description: Operation result object - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/OperationResultValueOnly' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /serialization: - get: - tags: - - Serialization API - summary: Returns an appropriate serialization based on the specified format (see SerializationFormat) - operationId: GenerateSerializationByIds - x-semanticIds: - - https://admin-shell.io/aas/API/GenerateSerializationByIds/3/0 - parameters: - - name: aasIds - in: query - description: The Asset Administration Shells' unique ids (UTF8-BASE64-URL-encoded) - style: form - explode: true - schema: - type: array - items: - type: string - - name: submodelIds - in: query - description: The Submodels' unique ids (UTF8-BASE64-URL-encoded) - style: form - explode: true - schema: - type: array - items: - type: string - - name: includeConceptDescriptions - in: query - description: Include Concept Descriptions? - style: form - explode: true - schema: - type: boolean - default: true - responses: - '200': - description: Requested serialization based on SerializationFormat - content: - application/asset-administration-shell-package+xml: - schema: - description: AASX package - type: string - format: binary - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0#/components/schemas/Environment' - application/xml: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0#/components/schemas/Environment' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /description: - get: - tags: - - Description API - summary: Returns the self-describing information of a network resource (ServiceDescription) - operationId: GetDescription - x-semanticIds: - - https://admin-shell.io/aas/API/Descriptor/GetDescription/3/0 - responses: - '200': - description: Requested Description - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/ServiceDescription' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' \ No newline at end of file diff --git a/AssetAdministrationShellServiceSpecification/V3.0-MinimalProfile.yaml b/AssetAdministrationShellServiceSpecification/V3.0-MinimalProfile.yaml deleted file mode 100644 index 5222c249..00000000 --- a/AssetAdministrationShellServiceSpecification/V3.0-MinimalProfile.yaml +++ /dev/null @@ -1,142 +0,0 @@ -openapi: 3.0.3 -info: - title: DotAAS Part 2 | HTTP/REST | Asset Adminstration Shell Service Specification - Minimal Profile - description: An exemplary API combination for the use case of a standalone Asset Administration Shell, e.g., an Asset Administration Shell running in a Docker container - contact: - name: Constantin Ziesche, Andreas Orzelski, Florian Krebs, Bastian Rössl, Manuel Sauer, Jens Vialkowitsch, Michael Hoffmeister, Torben Miny, Sebastian Bader, Marko Ristin, Nico Braunisch - version: V3.0-MinimalProfile - termsOfService: https://github.com/admin-shell-io/aas-specs -servers: -- url: '{protocol}://{host_name}:{port}/api/{version_prefix}' - variables: - protocol: - description: 'Allows access through http and https (recommended)' - enum: - - 'http' - - 'https' - default: 'https' - host_name: - default: admin-shell.io - description: 'Hostname of server hosting the api' - port: - enum: - - '80' - - '443' - default: '443' - description: '80 is default for http, 443 for https' - version_prefix: - enum: - - 'v3.0' - default: v3.0 -paths: - /aas: - get: - tags: - - Asset Administration Shell API - summary: Returns a specific Asset Administration Shell - operationId: GetAssetAdministrationShell - x-semanticIds: - - https://admin-shell.io/aas/API/GetAssetAdministrationShell/3/0 - responses: - '200': - description: Requested Asset Administration Shell - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0#/components/schemas/AssetAdministrationShell' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /aas/submodels/{submodelIdentifier}: - get: - tags: - - Asset Administration Shell API - summary: Returns the Submodel - operationId: GetSubmodel - x-semanticIds: - - https://admin-shell.io/aas/API/GetSubmodel/3/0 - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/SubmodelIdentifier' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Extent' - responses: - '200': - description: Requested Submodel - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0#/components/schemas/Submodel' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - - /aas/submodels/{submodelIdentifier}/submodel-elements/{idShortPath}/attachment: - get: - tags: - - Asset Administration Shell API - summary: Downloads file content from a specific submodel element from the Submodel at a specified path - operationId: GetFileByPath - x-semanticIds: - - https://admin-shell.io/aas/API/GetFileByPath/3/0 - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/SubmodelIdentifier' - - name: idShortPath - in: path - description: IdShort path to the submodel element (dot-separated) - required: true - style: simple - explode: false - schema: - type: string - responses: - '200': - description: Requested file - headers: - Content-Disposition: - schema: - type: string - description: In order to physically download the file usually set to attachment with a filename - example: 'attachment; filename="filename.jpg"' - content: - application/octet-stream: - schema: - type: string - format: binary - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /description: - get: - tags: - - Description API - summary: Returns the self-describing information of a network resource (ServiceDescription) - operationId: GetDescription - x-semanticIds: - - https://admin-shell.io/aas/API/Descriptor/GetDescription/3/0 - responses: - '200': - description: Requested Description - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/ServiceDescription' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' \ No newline at end of file diff --git a/AssetAdministrationShellServiceSpecification/V3.0-MinimalReadProfile.yaml b/AssetAdministrationShellServiceSpecification/V3.0-MinimalReadProfile.yaml deleted file mode 100644 index 3f7d79f7..00000000 --- a/AssetAdministrationShellServiceSpecification/V3.0-MinimalReadProfile.yaml +++ /dev/null @@ -1,142 +0,0 @@ -openapi: 3.0.3 -info: - title: DotAAS Part 2 | HTTP/REST | Asset Adminstration Shell Service Specification - Minimal Profile - description: An exemplary API combination for the use case of a standalone Asset Administration Shell, e.g., an Asset Administration Shell running in a Docker container - contact: - name: Constantin Ziesche, Andreas Orzelski, Florian Krebs, Bastian Rössl, Manuel Sauer, Jens Vialkowitsch, Michael Hoffmeister, Torben Miny, Sebastian Bader, Marko Ristin, Nico Braunisch - version: V3.0-MinimalReadProfile - termsOfService: https://github.com/admin-shell-io/aas-specs -servers: -- url: '{protocol}://{host_name}:{port}/api/{version_prefix}' - variables: - protocol: - description: 'Allows access through http and https (recommended)' - enum: - - 'http' - - 'https' - default: 'https' - host_name: - default: admin-shell.io - description: 'Hostname of server hosting the api' - port: - enum: - - '80' - - '443' - default: '443' - description: '80 is default for http, 443 for https' - version_prefix: - enum: - - 'v3.0' - default: v3.0 -paths: - /aas: - get: - tags: - - Asset Administration Shell API - summary: Returns a specific Asset Administration Shell - operationId: GetAssetAdministrationShell - x-semanticIds: - - https://admin-shell.io/aas/API/GetAssetAdministrationShell/3/0 - responses: - '200': - description: Requested Asset Administration Shell - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0#/components/schemas/AssetAdministrationShell' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /aas/submodels/{submodelIdentifier}: - get: - tags: - - Asset Administration Shell API - summary: Returns the Submodel - operationId: GetSubmodel - x-semanticIds: - - https://admin-shell.io/aas/API/GetSubmodel/3/0 - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/SubmodelIdentifier' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Extent' - responses: - '200': - description: Requested Submodel - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0#/components/schemas/Submodel' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - - /aas/submodels/{submodelIdentifier}/submodel-elements/{idShortPath}/attachment: - get: - tags: - - Asset Administration Shell API - summary: Downloads file content from a specific submodel element from the Submodel at a specified path - operationId: GetFileByPath - x-semanticIds: - - https://admin-shell.io/aas/API/GetFileByPath/3/0 - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/SubmodelIdentifier' - - name: idShortPath - in: path - description: IdShort path to the submodel element (dot-separated) - required: true - style: simple - explode: false - schema: - type: string - responses: - '200': - description: Requested file - headers: - Content-Disposition: - schema: - type: string - description: In order to physically download the file usually set to attachment with a filename - example: 'attachment; filename="filename.jpg"' - content: - application/octet-stream: - schema: - type: string - format: binary - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /description: - get: - tags: - - Description API - summary: Returns the self-describing information of a network resource (ServiceDescription) - operationId: GetDescription - x-semanticIds: - - https://admin-shell.io/aas/API/Descriptor/GetDescription/3/0 - responses: - '200': - description: Requested Description - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/ServiceDescription' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' \ No newline at end of file diff --git a/AssetAdministrationShellServiceSpecification/V3.0.yaml b/AssetAdministrationShellServiceSpecification/V3.0.yaml deleted file mode 100644 index 60d48714..00000000 --- a/AssetAdministrationShellServiceSpecification/V3.0.yaml +++ /dev/null @@ -1,1528 +0,0 @@ -openapi: 3.0.3 -info: - title: DotAAS Part 2 | HTTP/REST | Asset Adminstration Shell Service Specification - description: "An exemplary API combination for the use case of a standalone Asset Administration Shell, e.g., an Asset Administration Shell running in a Docker container. Publisher: Industrial Digital Twin Association (IDTA) 2023" - contact: - name: Industrial Digital Twin Association (IDTA) - email: info@idtwin.org - license: - name: CC BY 4.0 - url: https://creativecommons.org/licenses/by/4.0/ - version: V3.0 - termsOfService: https://github.com/admin-shell-io/aas-specs -servers: -- url: '{protocol}://{host_name}:{port}/api/{version_prefix}' - variables: - protocol: - description: 'Allows access through http and https (recommended)' - enum: - - 'http' - - 'https' - default: 'https' - host_name: - default: admin-shell.io - description: 'Hostname of server hosting the api' - port: - enum: - - '80' - - '443' - default: '443' - description: '80 is default for http, 443 for https' - version_prefix: - enum: - - 'v3.0' - default: v3.0 -paths: - /aas: - get: - tags: - - Asset Administration Shell API - summary: Returns a specific Asset Administration Shell - operationId: GetAssetAdministrationShell - x-semanticIds: - - https://admin-shell.io/aas/API/GetAssetAdministrationShell/3/0 - responses: - '200': - description: Requested Asset Administration Shell - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0#/components/schemas/AssetAdministrationShell' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - put: - tags: - - Asset Administration Shell API - summary: Updates an existing Asset Administration Shell - operationId: PutAssetAdministrationShell - x-semanticIds: - - https://admin-shell.io/aas/API/PutAssetAdministrationShell/3/0 - requestBody: - description: Asset Administration Shell object - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0#/components/schemas/AssetAdministrationShell' - required: true - responses: - '204': - description: Asset Administration Shell updated successfully - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - delete: - tags: - - Asset Administration Shell API - summary: Deletes an Asset Administration Shell - operationId: DeleteAssetAdministrationShell - x-semanticIds: - - https://admin-shell.io/aas/API/DeleteAssetAdministrationShell/3/0 - responses: - '204': - description: Asset Administration Shell deleted successfully - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /aas/$reference: - get: - tags: - - Asset Administration Shell API - summary: Returns a specific Asset Administration Shell as a Reference - operationId: GetAssetAdministrationShell-Reference - x-semanticIds: - - https://admin-shell.io/aas/API/GetAssetAdministrationShel/3/0 - responses: - '200': - description: Requested Asset Administration Shell - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0#/components/schemas/Reference' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /aas/asset-information: - get: - tags: - - Asset Administration Shell API - summary: Returns the Asset Information - operationId: GetAssetInformation - x-semanticIds: - - https://admin-shell.io/aas/API/GetAssetInformation/3/0 - responses: - '200': - description: Requested Asset Information - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0#/components/schemas/AssetInformation' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - put: - tags: - - Asset Administration Shell API - summary: Updates the Asset Information - operationId: PutAssetInformation - x-semanticIds: - - https://admin-shell.io/aas/API/PutAssetInformation/3/0 - requestBody: - description: Asset Information object - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0#/components/schemas/AssetInformation' - required: true - responses: - '204': - description: Asset Information updated successfully - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - - /aas/asset-information/thumbnail: - get: - tags: - - Asset Administration Shell API - operationId: GetThumbnail - x-semanticIds: - - https://admin-shell.io/aas/API/GetThumbnail/3/0 - responses: - '200': - description: The thumbnail of the Asset Information. - content: - application/octet-stream: - schema: - type: string - format: binary - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - put: - tags: - - Asset Administration Shell API - operationId: PutThumbnail - x-semanticIds: - - https://admin-shell.io/aas/API/PutThumbnail/3/0 - requestBody: - description: Thumbnail to upload - content: - multipart/form-data: - schema: - type: object - properties: - fileName: - type: string - file: - type: string - format: binary - encoding: - file: - contentType: application/octet-stream - required: true - responses: - '204': - description: Thumbnail updated successfully - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - delete: - tags: - - Asset Administration Shell API - operationId: DeleteThumbnail - x-semanticIds: - - https://admin-shell.io/aas/API/DeleteThumbnail/3/0 - responses: - '200': - description: Thumbnail deletion successful - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /aas/submodel-refs: - get: - tags: - - Asset Administration Shell API - summary: Returns all submodel references - operationId: GetAllSubmodelReferences - x-semanticIds: - - https://admin-shell.io/aas/API/GetAllSubmodelReferences/3/0 - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Limit' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Cursor' - responses: - '200': - description: Requested submodel references - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/GetReferencesResult' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - post: - tags: - - Asset Administration Shell API - summary: Creates a submodel reference at the Asset Administration Shell - operationId: PostSubmodelReference - x-semanticIds: - - https://admin-shell.io/aas/API/PostSubmodelReference/3/0 - requestBody: - description: Reference to the Submodel - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0#/components/schemas/Reference' - required: true - responses: - '201': - description: Submodel reference created successfully - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0#/components/schemas/Reference' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '409': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/conflict' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /aas/submodel-refs/{submodelIdentifier}: - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/SubmodelIdentifier' - delete: - tags: - - Asset Administration Shell API - summary: Deletes the submodel reference from the Asset Administration Shell. Does not delete the submodel itself! - operationId: DeleteSubmodelReferenceById - x-semanticIds: - - https://admin-shell.io/aas/API/DeleteSubmodelReference/3/0 - responses: - '204': - description: Submodel reference deleted successfully - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /aas/submodels/{submodelIdentifier}: - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/SubmodelIdentifier' - get: - tags: - - Asset Administration Shell API - summary: Returns the Submodel - operationId: GetSubmodel - x-semanticIds: - - https://admin-shell.io/aas/API/GetSubmodel/3/0 - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Level' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Extent' - responses: - '200': - description: Requested Submodel - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0#/components/schemas/Submodel' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - put: - tags: - - Asset Administration Shell API - summary: Updates the Submodel - operationId: PutSubmodel - x-semanticIds: - - https://admin-shell.io/aas/API/PutSubmodel/3/0 - parameters: - #- $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Level' - - name: level - in: query - description: Determines the structural depth of the respective resource content - required: false - schema: - type: string - default: deep - enum: - - deep # only 'deep' is allowed for PUT - #- core - requestBody: - description: Submodel object - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0#/components/schemas/Submodel' - required: true - responses: - '204': - description: Submodel updated successfully - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - patch: - tags: - - Asset Administration Shell API - summary: Updates the Submodel - operationId: PatchSubmodel - x-semanticIds: - - https://admin-shell.io/aas/API/PutSubmodel/3/0 - parameters: - #- $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Level' - - name: level - in: query - description: Determines the structural depth of the respective resource content - required: false - schema: - type: string - default: core - enum: - #- deep - - core # only 'deep' is allowed for PUT # TODO: is PATCH not PUT - requestBody: - description: Submodel object - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0#/components/schemas/Submodel' - required: true - responses: - '204': - description: Submodel updated successfully - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - delete: - tags: - - Asset Administration Shell API - summary: Deletes the submodel from the Asset Administration Shell. - operationId: DeleteSubmodelById - x-semanticIds: - - https://admin-shell.io/aas/API/DeleteSubmodelById/3/0 - responses: - '204': - description: Submodel deleted successfully - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /aas/submodels/{submodelIdentifier}/$metadata: - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/SubmodelIdentifier' - get: - tags: - - Asset Administration Shell API - summary: Returns the Submodel's metadata elements - operationId: GetSubmodel-Metadata - x-semanticIds: - - https://admin-shell.io/aas/API/GetSubmodel/3/0 - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Level' - responses: - '200': - description: Requested Submodel - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/SubmodelMetadata' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - patch: - tags: - - Asset Administration Shell API - summary: Updates the metadata attributes of the Submodel - operationId: PatchSubmodelMetadata - x-semanticIds: - - https://admin-shell.io/aas/API/PutSubmodel/3/0 - parameters: - #- $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Level' - - name: level - in: query - description: Determines the structural depth of the respective resource content - required: false - schema: - type: string - default: core - enum: - #- deep - - core # only 'deep' is allowed for PUT - requestBody: - description: Submodel object - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/SubmodelMetadata' - required: true - responses: - '204': - description: Submodel updated successfully - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /aas/submodels/{submodelIdentifier}/$value: - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/SubmodelIdentifier' - get: - tags: - - Asset Administration Shell API - summary: Returns the Submodel's ValueOnly representation - operationId: GetSubmodel-ValueOnly - x-semanticIds: - - https://admin-shell.io/aas/API/GetSubmodel/3/0 - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Level' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Extent' - responses: - '200': - description: Requested Submodel - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/SubmodelValue' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - patch: - tags: - - Asset Administration Shell API - summary: Updates teh values of the Submodel - operationId: PatchSubmodel-ValueOnly - x-semanticIds: - - https://admin-shell.io/aas/API/PutSubmodel/3/0 - parameters: - #- $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Level' - - name: level - in: query - description: Determines the structural depth of the respective resource content - required: false - schema: - type: string - default: core - enum: - #- deep - - core # only 'deep' is allowed for PUT - requestBody: - description: Submodel object in the ValueOnly representation - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/SubmodelValue' - required: true - responses: - '204': - description: Submodel updated successfully - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /aas/submodels/{submodelIdentifier}/$reference: - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/SubmodelIdentifier' - get: - tags: - - Asset Administration Shell API - summary: Returns the Submodel as a Reference - operationId: GetSubmodelMetadata-Reference - x-semanticIds: - - https://admin-shell.io/aas/API/GetSubmodel/3/0 - parameters: - #- $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Level' - - name: level - in: query - description: Determines the structural depth of the respective resource content - required: false - schema: - type: string - default: core - enum: - # - deep - - core # only 'core' is allowed for Content=Reference - responses: - '200': - description: Requested Submodel as a Reference - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0#/components/schemas/Reference' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - - /aas/submodels/{submodelIdentifier}/$path: - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/SubmodelIdentifier' - get: - tags: - - Asset Administration Shell API - summary: Returns the Submodel's metadata elements - operationId: GetSubmodel-Path - x-semanticIds: - - https://admin-shell.io/aas/API/GetSubmodel/3/0 - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Level' - responses: - '200': - description: Requested Submodel in Path notation - content: - application/json: - schema: - type: array - items: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/PathItem' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /aas/submodels/{submodelIdentifier}/submodel-elements: - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/SubmodelIdentifier' - get: - tags: - - Asset Administration Shell API - summary: Returns all submodel elements including their hierarchy - operationId: GetAllSubmodelElements - x-semanticIds: - - https://admin-shell.io/aas/API/GetAllSubmodelElements/3/0 - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Limit' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Cursor' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Level' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Extent' - responses: - '200': - description: List of found submodel elements - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/GetSubmodelElementsResult' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - post: - tags: - - Asset Administration Shell API - summary: Creates a new submodel element - operationId: PostSubmodelElement - x-semanticIds: - - https://admin-shell.io/aas/API/PostSubmodelElement/3/0 - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Level' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Extent' - requestBody: - description: Requested submodel element - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0#/components/schemas/SubmodelElement' - required: true - responses: - '201': - description: Submodel element created successfully - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0#/components/schemas/SubmodelElement' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '409': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/conflict' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /aas/submodels/{submodelIdentifier}/submodel-elements/$metadata: - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/SubmodelIdentifier' - get: - tags: - - Asset Administration Shell API - summary: Returns all submodel elements including their hierarchy - operationId: GetAllSubmodelElements-Metadata - x-semanticIds: - - https://admin-shell.io/aas/API/GetAllSubmodelElements/3/0 - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Limit' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Cursor' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Level' - responses: - '200': - description: List of found submodel elements - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/GetSubmodelElementsMetadataResult' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /aas/submodels/{submodelIdentifier}/submodel-elements/$value: - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/SubmodelIdentifier' - get: - tags: - - Asset Administration Shell API - summary: Returns all submodel elements including their hierarchy in the ValueOnly representation - operationId: GetAllSubmodelElements-ValueOnly - x-semanticIds: - - https://admin-shell.io/aas/API/GetAllSubmodelElements/3/0 - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Limit' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Cursor' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Level' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Extent' - responses: - '200': - description: List of found submodel elements in their ValueOnly representation - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/GetSubmodelElementsValueResult' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /aas/submodels/{submodelIdentifier}/submodel-elements/$reference: - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/SubmodelIdentifier' - get: - tags: - - Asset Administration Shell API - summary: Returns all submodel elements as a list of References - operationId: GetAllSubmodelElementsReference - x-semanticIds: - - https://admin-shell.io/aas/API/GetAllSubmodelElements/3/0 - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Limit' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Cursor' - #- $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Level' - - name: level - in: query - description: Determines the structural depth of the respective resource content - required: false - schema: - type: string - default: core - enum: - # - deep - - core # only 'core' is allowed for Content=Reference - responses: - '200': - description: List of References of the found submodel elements - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/GetReferencesResult' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /aas/submodels/{submodelIdentifier}/submodel-elements/$path: - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/SubmodelIdentifier' - get: - tags: - - Asset Administration Shell API - summary: Returns all submodel elements including their hierarchy - operationId: GetAllSubmodelElementsPath - x-semanticIds: - - https://admin-shell.io/aas/API/GetAllSubmodelElements/3/0 - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Limit' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Cursor' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Level' - responses: - '200': - description: List of found submodel elements in the Path notation - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/GetPathItemsResult' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /aas/submodels/{submodelIdentifier}/submodel-elements/{idShortPath}: - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/SubmodelIdentifier' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/IdShortPath' - get: - tags: - - Asset Administration Shell API - summary: Returns a specific submodel element from the Submodel at a specified - path - operationId: GetSubmodelElementByPath - x-semanticIds: - - https://admin-shell.io/aas/API/GetSubmodelElementByPath/3/0 - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Limit' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Cursor' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Level' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Extent' - responses: - '200': - description: Requested submodel element - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/GetSubmodelElementsResult' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - post: - tags: - - Asset Administration Shell API - summary: Creates a new submodel element at a specified path within submodel elements hierarchy - operationId: PostSubmodelElementByPath - x-semanticIds: - - https://admin-shell.io/aas/API/PostSubmodelElementByPath/3/0 - requestBody: - description: Requested submodel element - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0#/components/schemas/SubmodelElement' - required: true - responses: - '201': - description: Submodel element created successfully - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0#/components/schemas/SubmodelElement' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '409': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/conflict' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - put: - tags: - - Asset Administration Shell API - summary: Updates an existing submodel element at a specified path within submodel elements hierarchy - operationId: PutSubmodelElementByPath - x-semanticIds: - - https://admin-shell.io/aas/API/PutSubmodelElementByPath/3/0 - - https://admin-shell.io/aas/API/SetSubmodelElementValueByPath/3/0 - requestBody: - description: Requested submodel element - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0#/components/schemas/SubmodelElement' - required: true - responses: - '204': - description: Submodel element updated successfully - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - patch: - tags: - - Asset Administration Shell API - summary: Updates an existing submodel element value at a specified path within submodel elements hierarchy - operationId: PatchSubmodelElementValueByPath - x-semanticIds: - - https://admin-shell.io/aas/API/PatchSubmodelElementByPath/3/0 - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Level' - requestBody: - description: The updated value of the submodel element - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0#/components/schemas/SubmodelElement' - required: true - responses: - '204': - description: Submodel element updated successfully - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - delete: - tags: - - Asset Administration Shell API - summary: Deletes a submodel element at a specified path within the submodel elements hierarchy - operationId: DeleteSubmodelElementByPath - x-semanticIds: - - https://admin-shell.io/aas/API/DeleteSubmodelElementByPath/3/0 - responses: - '204': - description: Submodel element deleted successfully - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /aas/submodels/{submodelIdentifier}/submodel-elements/{idShortPath}/$metadata: - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/SubmodelIdentifier' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/IdShortPath' - get: - tags: - - Asset Administration Shell API - summary: Returns the metadata attributes if a specific submodel element from the Submodel at a specified - path - operationId: GetSubmodelElementByPath-Metadata - x-semanticIds: - - https://admin-shell.io/aas/API/GetSubmodelElementByPath/3/0 - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Limit' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Cursor' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Level' - responses: - '200': - description: Requested submodel element - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/GetSubmodelElementsMetadataResult' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - patch: - tags: - - Asset Administration Shell API - summary: Updates the metadata attributes of an existing submodel element value at a specified path within submodel elements hierarchy - operationId: PatchSubmodelElementValueByPath-Metadata - x-semanticIds: - - https://admin-shell.io/aas/API/PatchSubmodelElementByPath/3/0 - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Level' - requestBody: - description: The updated metadata attributes of the submodel element - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/SubmodelElementMetadata' - required: true - responses: - '204': - description: Submodel element updated successfully - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /aas/submodels/{submodelIdentifier}/submodel-elements/{idShortPath}/$value: - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/SubmodelIdentifier' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/IdShortPath' - get: - tags: - - Asset Administration Shell API - summary: Returns a specific submodel element from the Submodel at a specified - path in the ValueOnly representation - operationId: GetSubmodelElementByPath-ValueOnly - x-semanticIds: - - https://admin-shell.io/aas/API/GetSubmodelElementByPath/3/0 - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Limit' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Cursor' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Level' - responses: - '200': - description: Requested submodel element in its ValueOnly representation - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/GetSubmodelElementsValueResult' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - patch: - tags: - - Asset Administration Shell API - summary: Updates the value of an existing submodel element value at a specified path within submodel elements hierarchy - operationId: PatchSubmodelElementValueByPathValueOnly - x-semanticIds: - - https://admin-shell.io/aas/API/PatchSubmodelElementByPath/3/0 - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Level' - requestBody: - description: The updated value of the submodel element - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/SubmodelElementValue' - required: true - responses: - '204': - description: Submodel element updated successfully - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /aas/submodels/{submodelIdentifier}/submodel-elements/{idShortPath}/$reference: - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/SubmodelIdentifier' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/IdShortPath' - get: - tags: - - Asset Administration Shell API - summary: Returns the Reference of a specific submodel element from the Submodel at a specified - path in the ValueOnly representation - operationId: GetSubmodelElementByPath-Reference - x-semanticIds: - - https://admin-shell.io/aas/API/GetSubmodelElementByPath/3/0 - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Limit' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Cursor' - #- $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Level' - - name: level - in: query - description: Determines the structural depth of the respective resource content - required: false - schema: - type: string - default: core - enum: - # - deep - - core # only 'core' is allowed for Content=Reference - responses: - '200': - description: Requested submodel element in its ValueOnly representation - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/GetReferencesResult' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /aas/submodels/{submodelIdentifier}/submodel-elements/{idShortPath}/$path: - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/SubmodelIdentifier' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/IdShortPath' - get: - tags: - - Asset Administration Shell API - summary: Returns a specific submodel element from the Submodel at a specified path in the Path notation - operationId: GetSubmodelElementByPath-Path - x-semanticIds: - - https://admin-shell.io/aas/API/GetSubmodelElementByPath/3/0 - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Limit' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Cursor' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Level' - responses: - '200': - description: Requested submodel element in the Path notation - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/GetPathItemsResult' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /aas/submodels/{submodelIdentifier}/submodel-elements/{idShortPath}/attachment: - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/SubmodelIdentifier' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/IdShortPath' - get: - tags: - - Asset Administration Shell API - summary: Downloads file content from a specific submodel element from the Submodel at a specified path - operationId: GetFileByPath - x-semanticIds: - - https://admin-shell.io/aas/API/GetFileByPath/3/0 - responses: - '200': - description: Requested file - headers: - Content-Disposition: - schema: - type: string - description: In order to physically download the file usually set to attachment with a filename - example: 'attachment; filename="filename.jpg"' - content: - application/octet-stream: - schema: - type: string - format: binary - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - put: - tags: - - Asset Administration Shell API - summary: Uploads file content to an existing submodel element at a specified path within submodel elements hierarchy - operationId: PutFileByPath - x-semanticIds: - - https://admin-shell.io/aas/API/PutFileByPath/3/0 - requestBody: - description: File to upload - content: - multipart/form-data: - schema: - type: object - properties: - fileName: - type: string - file: - type: string - format: binary - encoding: - file: - contentType: application/octet-stream - required: true - responses: - '204': - description: Submodel element updated successfully - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - delete: - tags: - - Asset Administration Shell API - summary: Deletes file content of an existing submodel element at a specified path within submodel elements hierarchy - operationId: DeleteFileByPath - x-semanticIds: - - https://admin-shell.io/aas/API/DeleteFileByPath/3/0 - responses: - '200': - description: Submodel element updated successfully - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /aas/submodels/{submodelIdentifier}/submodel-elements/{idShortPath}/invoke: - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/SubmodelIdentifier' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/IdShortPath' - post: - tags: - - Asset Administration Shell API - summary: Synchronously or asynchronously invokes an Operation at a specified path - operationId: InvokeOperation - x-semanticIds: - - https://admin-shell.io/aas/API/InvokeOperationSync/3/0 - - https://admin-shell.io/aas/API/InvokeOperationAsync/3/0 - parameters: - - name: async - in: query - description: Determines whether an operation invocation is performed asynchronously or synchronously - schema: - type: boolean - default: false - requestBody: - description: Operation request object - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/OperationRequest' - required: true - responses: - '200': - description: Operation result object - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/OperationResult' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /aas/submodels/{submodelIdentifier}/submodel-elements/{idShortPath}/invoke/$value: - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/SubmodelIdentifier' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/IdShortPath' - post: - tags: - - Asset Administration Shell API - summary: Synchronously or asynchronously invokes an Operation at a specified path - operationId: InvokeOperation-ValueOnly - x-semanticIds: - - https://admin-shell.io/aas/API/InvokeOperationSync/3/0 - - https://admin-shell.io/aas/API/InvokeOperationAsync/3/0 - parameters: - - name: async - in: query - description: Determines whether an operation invocation is performed asynchronously or synchronously - schema: - type: boolean - default: false - requestBody: - description: Operation request object - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/OperationRequestValueOnly' - required: true - responses: - '200': - description: Operation result object - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/OperationResultValueOnly' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /aas/submodels/{submodelIdentifier}/submodel-elements/{idShortPath}/operation-results/{handleId}: - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/SubmodelIdentifier' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/AssetAdministrationShellIdentifier' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/IdShortPath' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/HandleId' - get: - tags: - - Asset Administration Shell API - summary: Returns the Operation result of an asynchronous invoked Operation - operationId: GetOperationAsyncResult - x-semanticIds: - - https://admin-shell.io/aas/API/GetOperationAsyncResult/3/0 - responses: - '200': - description: Operation result object - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/OperationResult' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /aas/submodels/{submodelIdentifier}/submodel-elements/{idShortPath}/operation-results/{handleId}/$value: - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/SubmodelIdentifier' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/AssetAdministrationShellIdentifier' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/IdShortPath' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/HandleId' - get: - tags: - - Asset Administration Shell API - summary: Returns the value of the Operation result of an asynchronous invoked Operation - operationId: GetOperationAsyncResult-ValueOnly - x-semanticIds: - - https://admin-shell.io/aas/API/GetOperationAsyncResult/3/0 - responses: - '200': - description: Operation result object - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/OperationResultValueOnly' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - - /serialization: - get: - tags: - - Serialization API - summary: Returns an appropriate serialization based on the specified format (see SerializationFormat) - operationId: GenerateSerializationByIds - x-semanticIds: - - https://admin-shell.io/aas/API/GenerateSerializationByIds/3/0 - parameters: - - name: aasIds - in: query - description: The Asset Administration Shells' unique ids (UTF8-BASE64-URL-encoded) - style: form - explode: true - schema: - type: array - items: - type: string - - name: submodelIds - in: query - description: The Submodels' unique ids (UTF8-BASE64-URL-encoded) - # TODO add in text that the recommended behavior is to also include all referenced and known Submodels directly - style: form - explode: true - schema: - type: array - items: - type: string - - name: includeConceptDescriptions - in: query - description: Include Concept Descriptions? - style: form - explode: true - schema: - type: boolean - default: true - responses: - '200': - description: Requested serialization based on SerializationFormat - content: - application/asset-administration-shell-package+xml: - schema: - description: AASX package - type: string - format: binary - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0#/components/schemas/Environment' - application/xml: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0#/components/schemas/Environment' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /description: - get: - tags: - - Description API - summary: Returns the self-describing information of a network resource (ServiceDescription) - operationId: GetDescription - x-semanticIds: - - https://admin-shell.io/aas/API/Descriptor/GetDescription/3/0 - responses: - '200': - description: Requested Description - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/ServiceDescription' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' \ No newline at end of file diff --git a/DINSPEC16593-Schemas/openapi.yaml b/DINSPEC16593-Schemas/openapi.yaml deleted file mode 100644 index b54c2466..00000000 --- a/DINSPEC16593-Schemas/openapi.yaml +++ /dev/null @@ -1,51 +0,0 @@ -# OpenAPI version identifier - required for OpenAPI 3.0 domains -openapi: 3.0.3 -info: - title: DotAAS Part 2 | DIN SPEC 16593 | Schemas - description: The schemas implementing DIN SPEC 16593 - contact: - name: Michael Hoffmeister, Torben Miny, Andreas Orzelski, Manuel Sauer, Constantin Ziesche, Sebastian Bader, Marko Ristin, Nico Braunisch - version: V1.0RC03 - termsOfService: https://github.com/admin-shell-io/aas-specs -components: - schemas: - Endpoint: - properties: - interface: - type: string - protocolInformation: - $ref: "#/components/schemas/ProtocolInformation" - required: - - protocolInformation - - interface - type: object - ProtocolInformation: - properties: - endpointAddress: - type: string - endpointProtocol: - type: string - endpointProtocolVersion: - type: string - subprotocol: - type: string - subprotocolBody: - type: string - subprotocolBodyEncoding: - type: string - securityAttributes: - type: array - items: - $ref: "#/components/schemas/SecurityAttribute" - required: - - endpointAddress - type: object - SecurityAttribute: - type: object - properties: - type: - type: string - key: - type: string - value: - type: string diff --git a/Entire-API-Collection/openapi.yaml b/Entire-API-Collection/openapi.yaml deleted file mode 100644 index 2f61f5b9..00000000 --- a/Entire-API-Collection/openapi.yaml +++ /dev/null @@ -1,6850 +0,0 @@ -openapi: 3.0.3 -info: - title: DotAAS Part 2 | HTTP/REST | Repository Service Specification - description: "The entire API collection as part of Details of the Asset Administration Shell Part 2. Publisher: Industrial Digital Twin Association (IDTA) 2023" - contact: - name: Industrial Digital Twin Association (IDTA) - email: info@idtwin.org - license: - name: CC BY 4.0 - url: https://creativecommons.org/licenses/by/4.0/ - version: V3.0 - termsOfService: https://github.com/admin-shell-io/aas-specs -servers: -- url: '{protocol}://{host_name}:{port}/api/{version_prefix}' - variables: - protocol: - description: 'Allows access through http and https (recommended)' - enum: - - 'http' - - 'https' - default: 'https' - host_name: - default: admin-shell.io - description: 'Hostname of server hosting the api' - port: - enum: - - '80' - - '443' - default: '443' - description: '80 is default for http, 443 for https' - version_prefix: - enum: - - 'v3.0' - default: v3.0 -paths: - - /aas: - get: - tags: - - Asset Administration Shell API - summary: Returns a specific Asset Administration Shell - operationId: GetAssetAdministrationShell - x-semanticIds: - - https://admin-shell.io/aas/API/GetAssetAdministrationShell/3/0 - responses: - '200': - description: Requested Asset Administration Shell - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0#/components/schemas/AssetAdministrationShell' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - put: - tags: - - Asset Administration Shell API - summary: Updates an existing Asset Administration Shell - operationId: PutAssetAdministrationShell - x-semanticIds: - - https://admin-shell.io/aas/API/PutAssetAdministrationShell/3/0 - requestBody: - description: Asset Administration Shell object - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0#/components/schemas/AssetAdministrationShell' - required: true - responses: - '204': - description: Asset Administration Shell updated successfully - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - delete: - tags: - - Asset Administration Shell API - summary: Deletes an Asset Administration Shell - operationId: DeleteAssetAdministrationShell - x-semanticIds: - - https://admin-shell.io/aas/API/DeleteAssetAdministrationShell/3/0 - responses: - '204': - description: Asset Administration Shell deleted successfully - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /aas/$reference: - get: - tags: - - Asset Administration Shell API - summary: Returns a specific Asset Administration Shell as a Reference - operationId: GetAssetAdministrationShell-Reference - x-semanticIds: - - https://admin-shell.io/aas/API/GetAssetAdministrationShel/3/0 - responses: - '200': - description: Requested Asset Administration Shell - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0#/components/schemas/Reference' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /aas/asset-information: - get: - tags: - - Asset Administration Shell API - summary: Returns the Asset Information - operationId: GetAssetInformation - x-semanticIds: - - https://admin-shell.io/aas/API/GetAssetInformation/3/0 - responses: - '200': - description: Requested Asset Information - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0#/components/schemas/AssetInformation' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - put: - tags: - - Asset Administration Shell API - summary: Updates the Asset Information - operationId: PutAssetInformation - x-semanticIds: - - https://admin-shell.io/aas/API/PutAssetInformation/3/0 - requestBody: - description: Asset Information object - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0#/components/schemas/AssetInformation' - required: true - responses: - '204': - description: Asset Information updated successfully - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - - /aas/asset-information/thumbnail: - get: - tags: - - Asset Administration Shell API - operationId: GetThumbnail - x-semanticIds: - - https://admin-shell.io/aas/API/GetThumbnail/3/0 - responses: - '200': - description: The thumbnail of the Asset Information. - content: - application/octet-stream: - schema: - type: string - format: binary - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - put: - tags: - - Asset Administration Shell API - operationId: PutThumbnail - x-semanticIds: - - https://admin-shell.io/aas/API/PutThumbnail/3/0 - requestBody: - description: Thumbnail to upload - content: - multipart/form-data: - schema: - type: object - properties: - fileName: - type: string - file: - type: string - format: binary - encoding: - file: - contentType: application/octet-stream - required: true - responses: - '204': - description: Thumbnail updated successfully - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - delete: - tags: - - Asset Administration Shell API - operationId: DeleteThumbnail - x-semanticIds: - - https://admin-shell.io/aas/API/DeleteThumbnail/3/0 - responses: - '200': - description: Thumbnail deletion successful - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /aas/submodel-refs: - get: - tags: - - Asset Administration Shell API - summary: Returns all submodel references - operationId: GetAllSubmodelReferences - x-semanticIds: - - https://admin-shell.io/aas/API/GetAllSubmodelReferences/3/0 - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Limit' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Cursor' - responses: - '200': - description: Requested submodel references - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/GetReferencesResult' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - post: - tags: - - Asset Administration Shell API - summary: Creates a submodel reference at the Asset Administration Shell - operationId: PostSubmodelReference - x-semanticIds: - - https://admin-shell.io/aas/API/PostSubmodelReference/3/0 - requestBody: - description: Reference to the Submodel - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0#/components/schemas/Reference' - required: true - responses: - '201': - description: Submodel reference created successfully - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0#/components/schemas/Reference' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '409': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/conflict' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /aas/submodel-refs/{submodelIdentifier}: - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/SubmodelIdentifier' - delete: - tags: - - Asset Administration Shell API - summary: Deletes the submodel reference from the Asset Administration Shell. Does not delete the submodel itself! - operationId: DeleteSubmodelReferenceById - x-semanticIds: - - https://admin-shell.io/aas/API/DeleteSubmodelReference/3/0 - responses: - '204': - description: Submodel reference deleted successfully - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /aas/submodels/{submodelIdentifier}: - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/SubmodelIdentifier' - get: - tags: - - Asset Administration Shell API - summary: Returns the Submodel - operationId: GetSubmodel_AAS - x-semanticIds: - - https://admin-shell.io/aas/API/GetSubmodel/3/0 - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Level' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Extent' - responses: - '200': - description: Requested Submodel - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0#/components/schemas/Submodel' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - put: - tags: - - Asset Administration Shell API - summary: Updates the Submodel - operationId: PutSubmodel_AAS - x-semanticIds: - - https://admin-shell.io/aas/API/PutSubmodel/3/0 - parameters: - #- $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Level' - - name: level - in: query - description: Determines the structural depth of the respective resource content - required: false - schema: - type: string - default: deep - enum: - - deep # only 'deep' is allowed for PUT - #- core - requestBody: - description: Submodel object - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0#/components/schemas/Submodel' - required: true - responses: - '204': - description: Submodel updated successfully - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - patch: - tags: - - Asset Administration Shell API - summary: Updates the Submodel - operationId: PatchSubmodel_AAS - x-semanticIds: - - https://admin-shell.io/aas/API/PutSubmodel/3/0 - parameters: - #- $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Level' - - name: level - in: query - description: Determines the structural depth of the respective resource content - required: false - schema: - type: string - default: core - enum: - #- deep - - core # only 'deep' is allowed for PUT # TODO: is PATCH not PUT - requestBody: - description: Submodel object - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0#/components/schemas/Submodel' - required: true - responses: - '204': - description: Submodel updated successfully - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - delete: - tags: - - Asset Administration Shell API - summary: Deletes the submodel from the Asset Administration Shell. - operationId: DeleteSubmodelById_AAS - x-semanticIds: - - https://admin-shell.io/aas/API/DeleteSubmodelById/3/0 - responses: - '204': - description: Submodel deleted successfully - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /aas/submodels/{submodelIdentifier}/$metadata: - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/SubmodelIdentifier' - get: - tags: - - Asset Administration Shell API - summary: Returns the Submodel's metadata elements - operationId: GetSubmodel-Metadata_AAS - x-semanticIds: - - https://admin-shell.io/aas/API/GetSubmodel/3/0 - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Level' - responses: - '200': - description: Requested Submodel - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/SubmodelMetadata' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - patch: - tags: - - Asset Administration Shell API - summary: Updates the metadata attributes of the Submodel - operationId: PatchSubmodelMetadata_AAS - x-semanticIds: - - https://admin-shell.io/aas/API/PutSubmodel/3/0 - parameters: - #- $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Level' - - name: level - in: query - description: Determines the structural depth of the respective resource content - required: false - schema: - type: string - default: core - enum: - #- deep - - core # only 'deep' is allowed for PUT - requestBody: - description: Submodel object - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/SubmodelMetadata' - required: true - responses: - '204': - description: Submodel updated successfully - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /aas/submodels/{submodelIdentifier}/$value: - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/SubmodelIdentifier' - get: - tags: - - Asset Administration Shell API - summary: Returns the Submodel's ValueOnly representation - operationId: GetSubmodel-ValueOnly_AAS - x-semanticIds: - - https://admin-shell.io/aas/API/GetSubmodel/3/0 - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Level' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Extent' - responses: - '200': - description: Requested Submodel - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/SubmodelValue' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - patch: - tags: - - Asset Administration Shell API - summary: Updates teh values of the Submodel - operationId: PatchSubmodel-ValueOnly_AAS - x-semanticIds: - - https://admin-shell.io/aas/API/PutSubmodel/3/0 - parameters: - #- $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Level' - - name: level - in: query - description: Determines the structural depth of the respective resource content - required: false - schema: - type: string - default: core - enum: - #- deep - - core # only 'deep' is allowed for PUT - requestBody: - description: Submodel object in the ValueOnly representation - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/SubmodelValue' - required: true - responses: - '204': - description: Submodel updated successfully - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /aas/submodels/{submodelIdentifier}/$reference: - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/SubmodelIdentifier' - get: - tags: - - Asset Administration Shell API - summary: Returns the Submodel as a Reference - operationId: GetSubmodelMetadata-Reference_AAS - x-semanticIds: - - https://admin-shell.io/aas/API/GetSubmodel/3/0 - parameters: - #- $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Level' - - name: level - in: query - description: Determines the structural depth of the respective resource content - required: false - schema: - type: string - default: core - enum: - # - deep - - core # only 'core' is allowed for Content=Reference - responses: - '200': - description: Requested Submodel as a Reference - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0#/components/schemas/Reference' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - - /aas/submodels/{submodelIdentifier}/$path: - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/SubmodelIdentifier' - get: - tags: - - Asset Administration Shell API - summary: Returns the Submodel's metadata elements - operationId: GetSubmodel-Path_AAS - x-semanticIds: - - https://admin-shell.io/aas/API/GetSubmodel/3/0 - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Level' - responses: - '200': - description: Requested Submodel in Path notation - content: - application/json: - schema: - type: array - items: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/PathItem' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /aas/submodels/{submodelIdentifier}/submodel-elements: - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/SubmodelIdentifier' - get: - tags: - - Asset Administration Shell API - summary: Returns all submodel elements including their hierarchy - operationId: GetAllSubmodelElements_AAS - x-semanticIds: - - https://admin-shell.io/aas/API/GetAllSubmodelElements/3/0 - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Limit' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Cursor' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Level' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Extent' - responses: - '200': - description: List of found submodel elements - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/GetSubmodelElementsResult' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - post: - tags: - - Asset Administration Shell API - summary: Creates a new submodel element - operationId: PostSubmodelElement_AAS - x-semanticIds: - - https://admin-shell.io/aas/API/PostSubmodelElement/3/0 - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Level' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Extent' - requestBody: - description: Requested submodel element - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0#/components/schemas/SubmodelElement' - required: true - responses: - '201': - description: Submodel element created successfully - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0#/components/schemas/SubmodelElement' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '409': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/conflict' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /aas/submodels/{submodelIdentifier}/submodel-elements/$metadata: - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/SubmodelIdentifier' - get: - tags: - - Asset Administration Shell API - summary: Returns all submodel elements including their hierarchy - operationId: GetAllSubmodelElements-Metadata_AAS - x-semanticIds: - - https://admin-shell.io/aas/API/GetAllSubmodelElements/3/0 - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Limit' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Cursor' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Level' - responses: - '200': - description: List of found submodel elements - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/GetSubmodelElementsMetadataResult' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /aas/submodels/{submodelIdentifier}/submodel-elements/$value: - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/SubmodelIdentifier' - get: - tags: - - Asset Administration Shell API - summary: Returns all submodel elements including their hierarchy in the ValueOnly representation - operationId: GetAllSubmodelElements-ValueOnly_AAS - x-semanticIds: - - https://admin-shell.io/aas/API/GetAllSubmodelElements/3/0 - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Limit' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Cursor' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Level' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Extent' - responses: - '200': - description: List of found submodel elements in their ValueOnly representation - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/GetSubmodelElementsValueResult' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /aas/submodels/{submodelIdentifier}/submodel-elements/$reference: - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/SubmodelIdentifier' - get: - tags: - - Asset Administration Shell API - summary: Returns all submodel elements as a list of References - operationId: GetAllSubmodelElementsReference_AAS - x-semanticIds: - - https://admin-shell.io/aas/API/GetAllSubmodelElements/3/0 - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Limit' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Cursor' - #- $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Level' - - name: level - in: query - description: Determines the structural depth of the respective resource content - required: false - schema: - type: string - default: core - enum: - # - deep - - core # only 'core' is allowed for Content=Reference - responses: - '200': - description: List of References of the found submodel elements - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/GetReferencesResult' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /aas/submodels/{submodelIdentifier}/submodel-elements/$path: - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/SubmodelIdentifier' - get: - tags: - - Asset Administration Shell API - summary: Returns all submodel elements including their hierarchy - operationId: GetAllSubmodelElementsPath_AAS - x-semanticIds: - - https://admin-shell.io/aas/API/GetAllSubmodelElements/3/0 - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Limit' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Cursor' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Level' - responses: - '200': - description: List of found submodel elements in the Path notation - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/GetPathItemsResult' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /aas/submodels/{submodelIdentifier}/submodel-elements/{idShortPath}: - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/SubmodelIdentifier' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/IdShortPath' - get: - tags: - - Asset Administration Shell API - summary: Returns a specific submodel element from the Submodel at a specified - path - operationId: GetSubmodelElementByPath_AAS - x-semanticIds: - - https://admin-shell.io/aas/API/GetSubmodelElementByPath/3/0 - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Limit' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Cursor' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Level' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Extent' - responses: - '200': - description: Requested submodel element - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/GetSubmodelElementsResult' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - post: - tags: - - Asset Administration Shell API - summary: Creates a new submodel element at a specified path within submodel elements hierarchy - operationId: PostSubmodelElementByPath_AAS - x-semanticIds: - - https://admin-shell.io/aas/API/PostSubmodelElementByPath/3/0 - requestBody: - description: Requested submodel element - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0#/components/schemas/SubmodelElement' - required: true - responses: - '201': - description: Submodel element created successfully - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0#/components/schemas/SubmodelElement' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '409': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/conflict' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - put: - tags: - - Asset Administration Shell API - summary: Updates an existing submodel element at a specified path within submodel elements hierarchy - operationId: PutSubmodelElementByPath_AAS - x-semanticIds: - - https://admin-shell.io/aas/API/PutSubmodelElementByPath/3/0 - - https://admin-shell.io/aas/API/SetSubmodelElementValueByPath/3/0 - requestBody: - description: Requested submodel element - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0#/components/schemas/SubmodelElement' - required: true - responses: - '204': - description: Submodel element updated successfully - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - patch: - tags: - - Asset Administration Shell API - summary: Updates an existing submodel element value at a specified path within submodel elements hierarchy - operationId: PatchSubmodelElementValueByPath_AAS - x-semanticIds: - - https://admin-shell.io/aas/API/PatchSubmodelElementByPath/3/0 - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Level' - requestBody: - description: The updated value of the submodel element - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0#/components/schemas/SubmodelElement' - required: true - responses: - '204': - description: Submodel element updated successfully - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - delete: - tags: - - Asset Administration Shell API - summary: Deletes a submodel element at a specified path within the submodel elements hierarchy - operationId: DeleteSubmodelElementByPath_AAS - x-semanticIds: - - https://admin-shell.io/aas/API/DeleteSubmodelElementByPath/3/0 - responses: - '204': - description: Submodel element deleted successfully - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /aas/submodels/{submodelIdentifier}/submodel-elements/{idShortPath}/$metadata: - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/SubmodelIdentifier' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/IdShortPath' - get: - tags: - - Asset Administration Shell API - summary: Returns the metadata attributes if a specific submodel element from the Submodel at a specified - path - operationId: GetSubmodelElementByPath-Metadata_AAS - x-semanticIds: - - https://admin-shell.io/aas/API/GetSubmodelElementByPath/3/0 - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Limit' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Cursor' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Level' - responses: - '200': - description: Requested submodel element - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/GetSubmodelElementsMetadataResult' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - patch: - tags: - - Asset Administration Shell API - summary: Updates the metadata attributes of an existing submodel element value at a specified path within submodel elements hierarchy - operationId: PatchSubmodelElementValueByPath-Metadata_AAS - x-semanticIds: - - https://admin-shell.io/aas/API/PatchSubmodelElementByPath/3/0 - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Level' - requestBody: - description: The updated metadata attributes of the submodel element - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/SubmodelElementMetadata' - required: true - responses: - '204': - description: Submodel element updated successfully - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /aas/submodels/{submodelIdentifier}/submodel-elements/{idShortPath}/$value: - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/SubmodelIdentifier' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/IdShortPath' - get: - tags: - - Asset Administration Shell API - summary: Returns a specific submodel element from the Submodel at a specified - path in the ValueOnly representation - operationId: GetSubmodelElementByPath-ValueOnly_AAS - x-semanticIds: - - https://admin-shell.io/aas/API/GetSubmodelElementByPath/3/0 - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Limit' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Cursor' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Level' - responses: - '200': - description: Requested submodel element in its ValueOnly representation - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/GetSubmodelElementsValueResult' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - patch: - tags: - - Asset Administration Shell API - summary: Updates the value of an existing submodel element value at a specified path within submodel elements hierarchy - operationId: PatchSubmodelElementValueByPathValueOnly_AAS - x-semanticIds: - - https://admin-shell.io/aas/API/PatchSubmodelElementByPath/3/0 - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Level' - requestBody: - description: The updated value of the submodel element - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/SubmodelElementValue' - required: true - responses: - '204': - description: Submodel element updated successfully - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /aas/submodels/{submodelIdentifier}/submodel-elements/{idShortPath}/$reference: - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/SubmodelIdentifier' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/IdShortPath' - get: - tags: - - Asset Administration Shell API - summary: Returns the Reference of a specific submodel element from the Submodel at a specified - path in the ValueOnly representation - operationId: GetSubmodelElementByPath-Reference_AAS - x-semanticIds: - - https://admin-shell.io/aas/API/GetSubmodelElementByPath/3/0 - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Limit' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Cursor' - #- $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Level' - - name: level - in: query - description: Determines the structural depth of the respective resource content - required: false - schema: - type: string - default: core - enum: - # - deep - - core # only 'core' is allowed for Content=Reference - responses: - '200': - description: Requested submodel element in its ValueOnly representation - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/GetReferencesResult' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /aas/submodels/{submodelIdentifier}/submodel-elements/{idShortPath}/$path: - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/SubmodelIdentifier' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/IdShortPath' - get: - tags: - - Asset Administration Shell API - summary: Returns a specific submodel element from the Submodel at a specified path in the Path notation - operationId: GetSubmodelElementByPath-Path_AAS - x-semanticIds: - - https://admin-shell.io/aas/API/GetSubmodelElementByPath/3/0 - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Limit' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Cursor' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Level' - responses: - '200': - description: Requested submodel element in the Path notation - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/GetPathItemsResult' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /aas/submodels/{submodelIdentifier}/submodel-elements/{idShortPath}/attachment: - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/SubmodelIdentifier' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/IdShortPath' - get: - tags: - - Asset Administration Shell API - summary: Downloads file content from a specific submodel element from the Submodel at a specified path - operationId: GetFileByPath_AAS - x-semanticIds: - - https://admin-shell.io/aas/API/GetFileByPath/3/0 - responses: - '200': - description: Requested file - headers: - Content-Disposition: - schema: - type: string - description: In order to physically download the file usually set to attachment with a filename - example: 'attachment; filename="filename.jpg"' - content: - application/octet-stream: - schema: - type: string - format: binary - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - put: - tags: - - Asset Administration Shell API - summary: Uploads file content to an existing submodel element at a specified path within submodel elements hierarchy - operationId: PutFileByPath_AAS - x-semanticIds: - - https://admin-shell.io/aas/API/PutFileByPath/3/0 - requestBody: - description: File to upload - content: - multipart/form-data: - schema: - type: object - properties: - fileName: - type: string - file: - type: string - format: binary - encoding: - file: - contentType: application/octet-stream - required: true - responses: - '204': - description: Submodel element updated successfully - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - delete: - tags: - - Asset Administration Shell API - summary: Deletes file content of an existing submodel element at a specified path within submodel elements hierarchy - operationId: DeleteFileByPath_AAS - x-semanticIds: - - https://admin-shell.io/aas/API/DeleteFileByPath/3/0 - responses: - '200': - description: Submodel element updated successfully - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /aas/submodels/{submodelIdentifier}/submodel-elements/{idShortPath}/invoke: - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/SubmodelIdentifier' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/IdShortPath' - post: - tags: - - Asset Administration Shell API - summary: Synchronously or asynchronously invokes an Operation at a specified path - operationId: InvokeOperation_AAS - x-semanticIds: - - https://admin-shell.io/aas/API/InvokeOperationSync/3/0 - - https://admin-shell.io/aas/API/InvokeOperationAsync/3/0 - parameters: - - name: async - in: query - description: Determines whether an operation invocation is performed asynchronously or synchronously - schema: - type: boolean - default: false - requestBody: - description: Operation request object - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/OperationRequest' - required: true - responses: - '200': - description: Operation result object - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/OperationResult' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /aas/submodels/{submodelIdentifier}/submodel-elements/{idShortPath}/invoke/$value: - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/SubmodelIdentifier' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/IdShortPath' - post: - tags: - - Asset Administration Shell API - summary: Synchronously or asynchronously invokes an Operation at a specified path - operationId: InvokeOperation-ValueOnly_AAS - x-semanticIds: - - https://admin-shell.io/aas/API/InvokeOperationSync/3/0 - - https://admin-shell.io/aas/API/InvokeOperationAsync/3/0 - parameters: - - name: async - in: query - description: Determines whether an operation invocation is performed asynchronously or synchronously - schema: - type: boolean - default: false - requestBody: - description: Operation request object - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/OperationRequestValueOnly' - required: true - responses: - '200': - description: Operation result object - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/OperationResultValueOnly' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /aas/submodels/{submodelIdentifier}/submodel-elements/{idShortPath}/operation-results/{handleId}: - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/SubmodelIdentifier' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/AssetAdministrationShellIdentifier' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/IdShortPath' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/HandleId' - get: - tags: - - Asset Administration Shell API - summary: Returns the Operation result of an asynchronous invoked Operation - operationId: GetOperationAsyncResult_AAS - x-semanticIds: - - https://admin-shell.io/aas/API/GetOperationAsyncResult/3/0 - responses: - '200': - description: Operation result object - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/OperationResult' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /aas/submodels/{submodelIdentifier}/submodel-elements/{idShortPath}/operation-results/{handleId}/$value: - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/SubmodelIdentifier' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/AssetAdministrationShellIdentifier' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/IdShortPath' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/HandleId' - get: - tags: - - Asset Administration Shell API - summary: Returns the value of the Operation result of an asynchronous invoked Operation - operationId: GetOperationAsyncResult-ValueOnly_AAS - x-semanticIds: - - https://admin-shell.io/aas/API/GetOperationAsyncResult/3/0 - responses: - '200': - description: Operation result object - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/OperationResultValueOnly' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - - - /submodel: - get: - tags: - - Submodel API - summary: Returns the Submodel - operationId: GetSubmodel - x-semanticIds: - - https://admin-shell.io/aas/API/GetSubmodel/3/0 - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Level' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Extent' - responses: - '200': - description: Requested Submodel - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0#/components/schemas/Submodel' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - put: - tags: - - Submodel API - summary: Updates the Submodel - operationId: PutSubmodel - x-semanticIds: - - https://admin-shell.io/aas/API/PutSubmodel/3/0 - parameters: - - name: level - in: query - description: Determines the structural depth of the respective resource content - required: false - schema: - type: string - default: deep - enum: - - deep # only 'deep' is allowed for PUT - #- core - requestBody: - description: Submodel object - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0#/components/schemas/Submodel' - required: true - responses: - '204': - description: Submodel updated successfully - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - patch: - tags: - - Submodel API - summary: Updates the Submodel - operationId: PatchSubmodel - x-semanticIds: - - https://admin-shell.io/aas/API/PatchSubmodel/3/0 - parameters: - #- $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Level' - - name: level - in: query - description: Determines the structural depth of the respective resource content - required: false - schema: - type: string - default: core - enum: - #- deep - - core # only 'core' is allowed for PATCH - requestBody: - description: Submodel object - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0#/components/schemas/Submodel' - required: true - responses: - '204': - description: Submodel updated successfully - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /submodel/$metadata: - get: - tags: - - Submodel API - summary: Returns the metadata attributes of a specific Submodel - operationId: GetSubmodel-Metadata - x-semanticIds: - - https://admin-shell.io/aas/API/GetSubmodel/3/0 - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Level' - responses: - '200': - description: Requested Submodel in the metadata representation - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/SubmodelMetadata' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - patch: - tags: - - Submodel API - summary: Updates the metadata attributes of the Submodel - operationId: PatchSubmodel-Metadata - x-semanticIds: - - https://admin-shell.io/aas/API/PatchSubmodel/3/0 - parameters: - #- $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Level' - - name: level - in: query - description: Determines the structural depth of the respective resource content - required: false - schema: - type: string - default: core - enum: - #- deep - - core # only 'core' is allowed for PATCH - requestBody: - description: The metadata attributes of the Submodel object - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/SubmodelMetadata' - required: true - responses: - '204': - description: Submodel updated successfully - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /submodel/$value: - get: - tags: - - Submodel API - summary: Returns the Submodel in the ValueOnly representation - operationId: GetSubmodel-ValueOnly - x-semanticIds: - - https://admin-shell.io/aas/API/GetSubmodelById/3/0 - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Level' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Extent' - responses: - '200': - description: ValueOnly representation of the Submodel - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/SubmodelValue' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - patch: - tags: - - Submodel API - summary: Updates the values of the Submodel - operationId: PatchSubmodel-ValueOnly - x-semanticIds: - - https://admin-shell.io/aas/API/PatchSubmodel/3/0 - parameters: - #- $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Level' - - name: level - in: query - description: Determines the structural depth of the respective resource content - required: false - schema: - type: string - default: core - enum: - #- deep - - core # only 'core' is allowed for PATCH - requestBody: - description: Submodel object in its ValueOnly representation - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/SubmodelValue' - required: true - responses: - '204': - description: Submodel updated successfully - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /submodel/$reference: - get: - tags: - - Submodel API - summary: Returns the Reference of the Submodel - operationId: GetSubmodel-Reference - x-semanticIds: - - https://admin-shell.io/aas/API/GetSubmodel/3/0 - parameters: - #- $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Level' - - name: level - in: query - description: Determines the structural depth of the respective resource content - required: false - schema: - type: string - default: core - enum: - # - deep - - core # only 'core' is allowed for Content=Reference - responses: - '200': - description: Requested Reference - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0#/components/schemas/Reference' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /submodel/$path: - get: - tags: - - Submodel API - summary: Returns the Submodel in the Path notation - operationId: GetSubmodel-Path - x-semanticIds: - - https://admin-shell.io/aas/API/GetSubmodelById/3/0 - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Level' - responses: - '200': - description: Submodel in Path notation - content: - application/json: - schema: - type: array - items: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/PathItem' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /submodel/submodel-elements: - get: - tags: - - Submodel API - summary: Returns all submodel elements including their hierarchy - operationId: GetAllSubmodelElements - x-semanticIds: - - https://admin-shell.io/aas/API/GetAllSubmodelElements/3/0 - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Limit' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Cursor' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Level' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Extent' - responses: - '200': - description: List of found submodel elements - content: - application/json: - schema: - type: array - items: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/GetSubmodelElementsResult' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - post: - tags: - - Submodel API - summary: Creates a new submodel element - operationId: PostSubmodelElement - x-semanticIds: - - https://admin-shell.io/aas/API/PostSubmodelElement/3/0 - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Level' - requestBody: - description: Requested submodel element - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0#/components/schemas/SubmodelElement' - required: true - responses: - '201': - description: Submodel element created successfully - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0#/components/schemas/SubmodelElement' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '409': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/conflict' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /submodel/submodel-elements/$metadata: - get: - tags: - - Submodel API - summary: Returns the metadata attributes of all submodel elements including their hierarchy - operationId: GetAllSubmodelElements-Metadata - x-semanticIds: - - https://admin-shell.io/aas/API/GetAllSubmodelElements/3/0 - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Limit' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Cursor' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Level' - responses: - '200': - description: List of found submodel elements - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/GetSubmodelElementsMetadataResult' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /submodel/submodel-elements/$value: - get: - tags: - - Submodel API - summary: Returns all submodel elements including their hierarchy in the ValueOnly representation - operationId: GetAllSubmodelElements-ValueOnly - x-semanticIds: - - https://admin-shell.io/aas/API/GetAllSubmodelElements/3/0 - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Limit' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Cursor' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Level' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Extent' - responses: - '200': - description: List of found submodel elements - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/GetSubmodelElementsValueResult' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /submodel/submodel-elements/$reference: - get: - tags: - - Submodel API - summary: Returns the References of all submodel elements - operationId: GetAllSubmodelElements-Reference - x-semanticIds: - - https://admin-shell.io/aas/API/GetAllSubmodelElements/3/0 - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Limit' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Cursor' - - name: level - in: query - description: Determines the structural depth of the respective resource content - required: false - schema: - type: string - default: core - enum: - # - deep - - core # only 'core' is allowed for Content=Reference - responses: - '200': - description: List of found submodel elements - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/GetReferencesResult' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /submodel/submodel-elements/$path: - get: - tags: - - Submodel API - summary: Returns all submodel elements including their hierarchy in the Path notation - operationId: GetAllSubmodelElements-Path - x-semanticIds: - - https://admin-shell.io/aas/API/GetAllSubmodelElements/3/0 - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Limit' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Cursor' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Level' - responses: - '200': - description: List of found submodel elements in the Path notation - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/GetPathItemsResult' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /submodel/submodel-elements/{idShortPath}: - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/IdShortPath' - get: - tags: - - Submodel API - summary: Returns a specific submodel element from the Submodel at a specified - path - operationId: GetSubmodelElementByPath - x-semanticIds: - - https://admin-shell.io/aas/API/GetSubmodelElementByPath/3/0 - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Limit' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Cursor' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Level' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Extent' - responses: - '200': - description: Requested submodel element - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/GetSubmodelElementsResult' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - post: - tags: - - Submodel API - summary: Creates a new submodel element at a specified path within submodel elements hierarchy - operationId: PostSubmodelElementByPath - x-semanticIds: - - https://admin-shell.io/aas/API/PostSubmodelElementByPath/3/0 - requestBody: - description: Requested submodel element - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0#/components/schemas/SubmodelElement' - required: true - responses: - '201': - description: Submodel element created successfully - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0#/components/schemas/SubmodelElement' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '409': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/conflict' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - put: - tags: - - Submodel API - summary: Updates an existing submodel element at a specified path within submodel elements hierarchy - operationId: PutSubmodelElementByPath - x-semanticIds: - - https://admin-shell.io/aas/API/PutSubmodelElementByPath/3/0 - - https://admin-shell.io/aas/API/SetSubmodelElementValueByPath/3/0 - parameters: - #- $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Level' - - name: level - in: query - description: Determines the structural depth of the respective resource content - required: false - schema: - type: string - default: deep - enum: - - deep # only 'deep' is allowed for PUT - #- core - requestBody: - description: Requested submodel element - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0#/components/schemas/SubmodelElement' - required: true - responses: - '204': - description: Submodel element updated successfully - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - patch: - tags: - - Submodel API - summary: Updates an existing SubmodelElement - operationId: PatchSubmodelElementByPath - x-semanticIds: - - https://admin-shell.io/aas/API/PatchSubmodelById/3/0 - parameters: - #- $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Level' - - name: level - in: query - description: Determines the structural depth of the respective resource content - required: false - schema: - type: string - default: core - enum: - #- deep - - core # only 'core' is allowed for PATCH - requestBody: - description: SubmodelElement object - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0#/components/schemas/SubmodelElement' - required: true - responses: - '204': - description: SubmodelElement updated successfully - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - delete: - tags: - - Submodel API - summary: Deletes a submodel element at a specified path within the submodel elements hierarchy - operationId: DeleteSubmodelElementByPath - x-semanticIds: - - https://admin-shell.io/aas/API/DeleteSubmodelElementByPath/3/0 - responses: - '204': - description: Submodel element deleted successfully - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /submodel/submodel-elements/{idShortPath}/$metadata: - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/IdShortPath' - get: - tags: - - Submodel API - summary: Returns the matadata attributes of a specific submodel element from the Submodel at a specified - path - operationId: GetSubmodelElementByPath-Metadata - x-semanticIds: - - https://admin-shell.io/aas/API/GetSubmodelElementByPath/3/0 - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Level' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Limit' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Cursor' - responses: - '200': - description: Metadata attributes of the requested submodel element - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/GetSubmodelElementsMetadataResult' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - patch: - tags: - - Submodel API - summary: Updates the metadata attributes an existing SubmodelElement - operationId: PatchSubmodelElementByPath-Metadata - x-semanticIds: - - https://admin-shell.io/aas/API/PatchSubmodelElementByPath/3/0 - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Limit' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Cursor' - #- $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Level' - - name: level - in: query - description: Determines the structural depth of the respective resource content - required: false - schema: - type: string - default: core - enum: - #- deep - - core # only 'core' is allowed for PATCH - requestBody: - description: Metadata attributes of the SubmodelElement - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/GetSubmodelElementsMetadataResult' - required: true - responses: - '204': - description: SubmodelElement updated successfully - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /submodel/submodel-elements/{idShortPath}/$value: - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/IdShortPath' - get: - tags: - - Submodel API - summary: Returns a specific submodel element from the Submodel at a specified - path in the ValueOnly representation - operationId: GetSubmodelElementByPath-ValueOnly - x-semanticIds: - - https://admin-shell.io/aas/API/GetSubmodelElementByPath/3/0 - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Limit' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Cursor' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Level' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Extent' - responses: - '200': - description: Requested submodel element - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/GetSubmodelElementsValueResult' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - patch: - tags: - - Submodel API - summary: Updates the value of an existing SubmodelElement - operationId: PatchSubmodelElementByPath-ValueOnly - x-semanticIds: - - https://admin-shell.io/aas/API/PatchSubmodelElementByPath/3/0 - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Limit' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Cursor' - #- $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Level' - - name: level - in: query - description: Determines the structural depth of the respective resource content - required: false - schema: - type: string - default: core - enum: - #- deep - - core # only 'core' is allowed for PATCH - requestBody: - description: The SubmodelElement in its ValueOnly representation - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/GetSubmodelElementsValueResult' - required: true - responses: - '204': - description: Submodel updated successfully - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /submodel/submodel-elements/{idShortPath}/$reference: - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/IdShortPath' - get: - tags: - - Submodel API - summary: Returns the Referene of a specific submodel element from the Submodel at a specified - path - operationId: GetSubmodelElementByPath-Reference - x-semanticIds: - - https://admin-shell.io/aas/API/GetSubmodelElementByPath/3/0 - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Limit' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Cursor' - #- $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Level' - - name: level - in: query - description: Determines the structural depth of the respective resource content - required: false - schema: - type: string - default: core - enum: - # - deep - - core # only 'core' is allowed for Content=Reference - responses: - '200': - description: Requested submodel element - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/GetReferencesResult' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /submodel/submodel-elements/{idShortPath}/$path: - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/IdShortPath' - get: - tags: - - Submodel API - summary: Returns a specific submodel element from the Submodel at a specified - path in the Path notation - operationId: GetSubmodelElementByPath-Path - x-semanticIds: - - https://admin-shell.io/aas/API/GetSubmodelElementByPath/3/0 - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Limit' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Cursor' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Level' - responses: - '200': - description: Requested submodel element - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/GetPathItemsResult' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /submodel/submodel-elements/{idShortPath}/attachment: - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/IdShortPath' - get: - tags: - - Submodel API - summary: Downloads file content from a specific submodel element from the Submodel at a specified path - operationId: GetFileByPath - x-semanticIds: - - https://admin-shell.io/aas/API/GetFileByPath/3/0 - responses: - '200': - description: Requested file - headers: - Content-Disposition: - schema: - type: string - description: In order to physically download the file usually set to attachment with a filename - example: 'attachment; filename="filename.jpg"' - content: - application/octet-stream: - schema: - type: string - format: binary - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '405': - description: Method not allowed - Download only valid for File submodel element - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/Result' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - put: - tags: - - Submodel API - summary: Uploads file content to an existing submodel element at a specified path within submodel elements hierarchy - operationId: PutFileByPath - x-semanticIds: - - https://admin-shell.io/aas/API/PutFileByPath/3/0 - requestBody: - description: File to upload - content: - multipart/form-data: - schema: - type: object - properties: - fileName: - type: string - file: - type: string - format: binary - encoding: - file: - contentType: application/octet-stream - required: true - responses: - '204': - description: Submodel element updated successfully - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '405': - description: Method not allowed - Upload only valid for File submodel element - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/Result' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - delete: - tags: - - Submodel API - summary: Deletes file content of an existing submodel element at a specified path within submodel elements hierarchy - operationId: DeleteFileByPath - x-semanticIds: - - https://admin-shell.io/aas/API/DeleteFileByPath/3/0 - responses: - '200': - description: Submodel element updated successfully - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /submodel/submodel-elements/{idShortPath}/invoke: - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/IdShortPath' - post: - tags: - - Submodel API - summary: Synchronously or asynchronously invokes an Operation at a specified path - operationId: InvokeOperation - x-semanticIds: - - https://admin-shell.io/aas/API/InvokeOperationSync/3/0 - - https://admin-shell.io/aas/API/InvokeOperationAsync/3/0 - parameters: - - name: async - in: query - description: Determines whether an operation invocation is performed asynchronously or synchronously - schema: - type: boolean - default: false - requestBody: - description: Operation request object - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/OperationRequest' - required: true - responses: - '200': - description: Operation result object - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/OperationResult' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '405': - description: Method not allowed - Invoke only valid for Operation submodel element - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/Result' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /submodel/submodel-elements/{idShortPath}/invoke-async: - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/IdShortPath' - post: - tags: - - Submodel API - summary: Synchronously or asynchronously invokes an Operation at a specified path - operationId: InvokeOperationAsync - x-semanticIds: - - https://admin-shell.io/aas/API/InvokeOperationSync/3/0 - - https://admin-shell.io/aas/API/InvokeOperationAsync/3/0 - parameters: - - name: async - in: query - description: Determines whether an operation invocation is performed asynchronously or synchronously - schema: - type: boolean - default: false - requestBody: - description: Operation request object - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/OperationRequest' - required: true - responses: - '200': - description: Operation result object - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/OperationResult' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '405': - description: Method not allowed - Invoke only valid for Operation submodel element - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/Result' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /submodel/submodel-elements/{idShortPath}/invoke/$value: - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/IdShortPath' - post: - tags: - - Submodel API - summary: Synchronously or asynchronously invokes an Operation at a specified path - operationId: InvokeOperation-ValueOnly - x-semanticIds: - - https://admin-shell.io/aas/API/InvokeOperationSync/3/0 - - https://admin-shell.io/aas/API/InvokeOperationAsync/3/0 - parameters: - - name: async - in: query - description: Determines whether an operation invocation is performed asynchronously or synchronously - schema: - type: boolean - default: false - requestBody: - description: Operation request object - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/OperationRequestValueOnly' - required: true - responses: - '200': - description: Operation result object - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/OperationResultValueOnly' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '405': - description: Method not allowed - Invoke only valid for Operation submodel element - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/Result' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /submodel/submodel-elements/{idShortPath}/operation-results/{handleId}: - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/IdShortPath' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/HandleId' - get: - tags: - - Submodel API - summary: Returns the Operation result of an asynchronous invoked Operation - operationId: GetOperationAsyncResult - x-semanticIds: - - https://admin-shell.io/aas/API/GetOperationAsyncResult/3/0 - responses: - '200': - description: Operation result object - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/OperationResult' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /submodel/submodel-elements/{idShortPath}/operation-results/{handleId}/$value: - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/IdShortPath' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/HandleId' - get: - tags: - - Submodel API - summary: Returns the value of the Operation result of an asynchronous invoked Operation - operationId: GetOperationAsyncResult-ValueOnly - x-semanticIds: - - https://admin-shell.io/aas/API/GetOperationAsyncResult/3/0 - responses: - '200': - description: Operation result object - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/OperationResultValueOnly' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - - /shells: - get: - tags: - - Asset Administration Shell Repository API - summary: Returns all Asset Administration Shells - operationId: GetAllAssetAdministrationShells - x-semanticIds: - - https://admin-shell.io/aas/API/GetAllAssetAdministrationShells/3/0 - - https://admin-shell.io/aas/API/GetAllAssetAdministrationShellsByAssetId/3/0 - - https://admin-shell.io/aas/API/GetAllAssetAdministrationShellsByIdShort/3/0 - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/AssetIds' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/IdShort' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Limit' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Cursor' - responses: - '200': - description: Requested Asset Administration Shells - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/GetAssetAdministrationShellsResult' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '401': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/unauthorized' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - post: - tags: - - Asset Administration Shell Repository API - summary: Creates a new Asset Administration Shell - operationId: PostAssetAdministrationShell - x-semanticIds: - - https://admin-shell.io/aas/API/PostAssetAdministrationShell/3/0 - requestBody: - description: Asset Administration Shell object - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0#/components/schemas/AssetAdministrationShell' - required: true - responses: - '201': - description: Asset Administration Shell created successfully - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0#/components/schemas/AssetAdministrationShell' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '401': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/unauthorized' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '409': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/conflict' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /shells/$reference: - get: - tags: - - Asset Administration Shell Repository API - summary: Returns References to all Asset Administration Shells - operationId: GetAllAssetAdministrationShells-Reference - x-semanticIds: - - https://admin-shell.io/aas/API/GetAllAssetAdministrationShells/3/0 - - https://admin-shell.io/aas/API/GetAllAssetAdministrationShellsByAssetId/3/0 - - https://admin-shell.io/aas/API/GetAllAssetAdministrationShellsByIdShort/3/0 - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/AssetIds' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/IdShort' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Limit' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Cursor' - responses: - '200': - description: Requested Asset Administration Shells as a list of References - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/GetReferencesResult' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '401': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/unauthorized' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /shells/{aasIdentifier}: - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/AssetAdministrationShellIdentifier' - get: - tags: - - Asset Administration Shell Repository API - summary: Returns a specific Asset Administration Shell - operationId: GetAssetAdministrationShellById - x-semanticIds: - - https://admin-shell.io/aas/API/GetAssetAdministrationShellById/3/0 - responses: - '200': - description: Requested Asset Administration Shell - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0#/components/schemas/AssetAdministrationShell' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '401': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/unauthorized' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - put: - tags: - - Asset Administration Shell Repository API - summary: Updates an existing Asset Administration Shell - operationId: PutAssetAdministrationShellById - x-semanticIds: - - https://admin-shell.io/aas/API/PutAssetAdministrationShellById/3/0 - requestBody: - description: Asset Administration Shell object - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0#/components/schemas/AssetAdministrationShell' - required: true - responses: - '204': - description: Asset Administration Shell updated successfully - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '401': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/unauthorized' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - delete: - tags: - - Asset Administration Shell Repository API - summary: Deletes an Asset Administration Shell - operationId: DeleteAssetAdministrationShellById - x-semanticIds: - - https://admin-shell.io/aas/API/DeleteAssetAdministrationShellById/3/0 - responses: - '204': - description: Asset Administration Shell deleted successfully - '401': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/unauthorized' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - description: Not Found - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/Result' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - description: Default error handling for unmentioned status codes - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/Result' - /shells/{aasIdentifier}/$reference: - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/AssetAdministrationShellIdentifier' - get: - tags: - - Asset Administration Shell Repository API - summary: Returns a specific Asset Administration Shell as a Reference - operationId: GetAssetAdministrationShellById-Reference_AasRepository - x-semanticIds: - - https://admin-shell.io/aas/API/GetAssetAdministrationShellById/3/0 - responses: - '200': - description: Requested Asset Administration Shell - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0#/components/schemas/Reference' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '401': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/unauthorized' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /shells/{aasIdentifier}/asset-information: - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/AssetAdministrationShellIdentifier' - get: - tags: - - Asset Administration Shell Repository API - summary: Returns the Asset Information - operationId: GetAssetInformation_AasRepository - x-semanticIds: - - https://admin-shell.io/aas/API/GetAssetInformation/3/0 - responses: - '200': - description: Requested Asset Information - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0#/components/schemas/AssetInformation' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '401': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/unauthorized' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - put: - tags: - - Asset Administration Shell Repository API - summary: Updates the Asset Information - operationId: PutAssetInformation_AasRepository - x-semanticIds: - - https://admin-shell.io/aas/API/PutAssetInformation/3/0 - requestBody: - description: Asset Information object - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0#/components/schemas/AssetInformation' - required: true - responses: - '204': - description: Asset Information updated successfully - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '401': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/unauthorized' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /shells/{aasIdentifier}/asset-information/thumbnail: - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/AssetAdministrationShellIdentifier' - get: - tags: - - Asset Administration Shell Repository API - operationId: GetThumbnail_AasRepository - x-semanticIds: - - https://admin-shell.io/aas/API/GetThumbnail/3/0 - responses: - '200': - description: The thumbnail of the Asset Information. - content: - application/octet-stream: - schema: - type: string - format: binary - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '401': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/unauthorized' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - put: - tags: - - Asset Administration Shell Repository API - operationId: PutThumbnail_AasRepository - x-semanticIds: - - https://admin-shell.io/aas/API/PutThumbnail/3/0 - requestBody: - description: Thumbnail to upload - content: - multipart/form-data: - schema: - type: object - properties: - fileName: - type: string - file: - type: string - format: binary - encoding: - file: - contentType: application/octet-stream - required: true - responses: - '204': - description: Thumbnail updated successfully - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '401': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/unauthorized' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - delete: - tags: - - Asset Administration Shell Repository API - operationId: DeleteThumbnail_AasRepository - x-semanticIds: - - https://admin-shell.io/aas/API/DeleteThumbnail/3/0 - responses: - '200': - description: Thumbnail deletion successful - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '401': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/unauthorized' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /shells/{aasIdentifier}/submodel-refs: - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/AssetAdministrationShellIdentifier' - get: - tags: - - Asset Administration Shell Repository API - summary: Returns all submodel references - operationId: GetAllSubmodelReferences_AasRepository - x-semanticIds: - - https://admin-shell.io/aas/API/GetAllSubmodelReferences/3/0 - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Limit' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Cursor' - responses: - '200': - description: Requested submodel references - content: - application/json: - schema: - type: array - items: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/GetReferencesResult' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '401': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/unauthorized' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - post: - tags: - - Asset Administration Shell Repository API - summary: Creates a submodel reference at the Asset Administration Shell - operationId: PostSubmodelReference_AasRepository - x-semanticIds: - - https://admin-shell.io/aas/API/PostSubmodelReference/3/0 - requestBody: - description: Reference to the Submodel - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0#/components/schemas/Reference' - required: true - responses: - '201': - description: Submodel reference created successfully - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0#/components/schemas/Reference' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '401': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/unauthorized' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '409': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/conflict' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /shells/{aasIdentifier}/submodel-refs/{submodelIdentifier}: - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/AssetAdministrationShellIdentifier' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/SubmodelIdentifier' - delete: - tags: - - Asset Administration Shell Repository API - summary: Deletes the submodel reference from the Asset Administration Shell. Does not delete the submodel itself! - operationId: DeleteSubmodelReferenceById_AasRepository - x-semanticIds: - - https://admin-shell.io/aas/API/DeleteSubmodelReference/3/0 - responses: - '204': - description: Submodel reference deleted successfully - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '401': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/unauthorized' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /shells/{aasIdentifier}/submodels/{submodelIdentifier}: - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/AssetAdministrationShellIdentifier' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/SubmodelIdentifier' - get: - tags: - - Asset Administration Shell Repository API - summary: Returns the Submodel - operationId: GetSubmodelById_AasRepository - x-semanticIds: - - https://admin-shell.io/aas/API/GetSubmodel/3/0 - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Level' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Extent' - responses: - '200': - description: Requested Submodel - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0#/components/schemas/Submodel' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '401': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/unauthorized' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - put: - tags: - - Asset Administration Shell Repository API - summary: Updates the Submodel - operationId: PutSubmodelById_AasRepository - x-semanticIds: - - https://admin-shell.io/aas/API/PutSubmodel/3/0 - parameters: - #- $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Level' - - name: level - in: query - description: Determines the structural depth of the respective resource content - required: false - schema: - type: string - default: deep - enum: - - deep # only 'deep' is allowed for PUT - #- core - requestBody: - description: Submodel object - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0#/components/schemas/Submodel' - required: true - responses: - '204': - description: Submodel updated successfully - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '401': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/unauthorized' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - patch: - tags: - - Asset Administration Shell Repository API - summary: Updates the Submodel - operationId: PatchSubmodel_AasRepository - x-semanticIds: - - https://admin-shell.io/aas/API/PutSubmodel/3/0 - parameters: - #- $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Level' - - name: level - in: query - description: Determines the structural depth of the respective resource content - required: false - schema: - type: string - default: core - enum: - #- deep - - core # only 'deep' is allowed for PUT - requestBody: - description: Submodel object - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0#/components/schemas/Submodel' - required: true - responses: - '204': - description: Submodel updated successfully - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '401': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/unauthorized' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /shells/{aasIdentifier}/submodels/{submodelIdentifier}/$metadata: - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/AssetAdministrationShellIdentifier' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/SubmodelIdentifier' - delete: - tags: - - Asset Administration Shell Repository API - summary: Deletes the submodel from the Asset Administration Shell and the Repository. - operationId: DeleteSubmodelById_AasRepository - x-semanticIds: - - https://admin-shell.io/aas/API/DeleteSubmodelById/3/0 - responses: - '204': - description: Submodel deleted successfully - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '401': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/unauthorized' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - get: - tags: - - Asset Administration Shell Repository API - summary: Returns the Submodel's metadata elements - operationId: GetSubmodelById-Metadata_AasRepository - x-semanticIds: - - https://admin-shell.io/aas/API/GetSubmodel/3/0 - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Level' - responses: - '200': - description: Requested Submodel - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/SubmodelMetadata' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '401': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/unauthorized' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - patch: - tags: - - Asset Administration Shell Repository API - summary: Updates the metadata attributes of the Submodel - operationId: PatchSubmodelById-Metadata_AasRepository - x-semanticIds: - - https://admin-shell.io/aas/API/PutSubmodel/3/0 - parameters: - #- $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Level' - - name: level - in: query - description: Determines the structural depth of the respective resource content - required: false - schema: - type: string - default: core - enum: - #- deep - - core # only 'deep' is allowed for PUT - requestBody: - description: Submodel object - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/SubmodelMetadata' - required: true - responses: - '204': - description: Submodel updated successfully - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '401': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/unauthorized' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /shells/{aasIdentifier}/submodels/{submodelIdentifier}/$value: - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/AssetAdministrationShellIdentifier' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/SubmodelIdentifier' - get: - tags: - - Asset Administration Shell Repository API - summary: Returns the Submodel's ValueOnly representation - operationId: GetSubmodelById-ValueOnly_AasRepository - x-semanticIds: - - https://admin-shell.io/aas/API/GetSubmodel/3/0 - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Level' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Extent' - responses: - '200': - description: Requested Submodel - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/SubmodelValue' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '401': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/unauthorized' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - patch: - tags: - - Asset Administration Shell Repository API - summary: Updates teh values of the Submodel - operationId: PatchSubmodelById-ValueOnly_AasRepository - x-semanticIds: - - https://admin-shell.io/aas/API/PutSubmodel/3/0 - parameters: - #- $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Level' - - name: level - in: query - description: Determines the structural depth of the respective resource content - required: false - schema: - type: string - default: core - enum: - #- deep - - core # only 'deep' is allowed for PUT - requestBody: - description: Submodel object in the ValueOnly representation - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/SubmodelValue' - required: true - responses: - '204': - description: Submodel updated successfully - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '401': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/unauthorized' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /shells/{aasIdentifier}/submodels/{submodelIdentifier}/$reference: - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/AssetAdministrationShellIdentifier' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/SubmodelIdentifier' - get: - tags: - - Asset Administration Shell Repository API - summary: Returns the Submodel as a Reference - operationId: GetSubmodelById-Reference_AasRepository - x-semanticIds: - - https://admin-shell.io/aas/API/GetSubmodel/3/0 - parameters: - - name: level - in: query - description: Determines the structural depth of the respective resource content - required: false - schema: - type: string - default: core - enum: - # - deep - - core # only 'core' is allowed for Content=Reference - responses: - '200': - description: Requested Submodel as a Reference - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0#/components/schemas/Reference' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '401': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/unauthorized' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - - /shells/{aasIdentifier}/submodels/{submodelIdentifier}/$path: - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/AssetAdministrationShellIdentifier' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/SubmodelIdentifier' - get: - tags: - - Asset Administration Shell Repository API - summary: Returns the Submodel's metadata elements - operationId: GetSubmodelById-Path_AasRepository - x-semanticIds: - - https://admin-shell.io/aas/API/GetSubmodel/3/0 - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Level' - responses: - '200': - description: Requested Submodel in Path notation - content: - application/json: - schema: - type: array - items: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/PathItem' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '401': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/unauthorized' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /shells/{aasIdentifier}/submodels/{submodelIdentifier}/submodel-elements: - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/AssetAdministrationShellIdentifier' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/SubmodelIdentifier' - get: - tags: - - Asset Administration Shell Repository API - summary: Returns all submodel elements including their hierarchy - operationId: GetAllSubmodelElements_AasRepository - x-semanticIds: - - https://admin-shell.io/aas/API/GetAllSubmodelElements/3/0 - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Limit' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Cursor' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Level' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Extent' - responses: - '200': - description: List of found submodel elements - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/GetSubmodelElementsResult' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '401': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/unauthorized' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - post: - tags: - - Asset Administration Shell Repository API - summary: Creates a new submodel element - operationId: PostSubmodelElement_AasRepository - x-semanticIds: - - https://admin-shell.io/aas/API/PostSubmodelElement/3/0 - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Level' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Extent' - requestBody: - description: Requested submodel element - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0#/components/schemas/SubmodelElement' - required: true - responses: - '201': - description: Submodel element created successfully - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0#/components/schemas/SubmodelElement' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '401': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/unauthorized' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '409': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/conflict' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /shells/{aasIdentifier}/submodels/{submodelIdentifier}/submodel-elements/$metadata: - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/AssetAdministrationShellIdentifier' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/SubmodelIdentifier' - get: - tags: - - Asset Administration Shell Repository API - summary: Returns all submodel elements including their hierarchy - operationId: GetAllSubmodelElements-Metadata_AasRepository - x-semanticIds: - - https://admin-shell.io/aas/API/GetAllSubmodelElements/3/0 - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Limit' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Cursor' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Level' - responses: - '200': - description: List of found submodel elements - content: - application/json: - schema: - type: array - items: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/GetSubmodelElementsMetadataResult' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '401': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/unauthorized' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /shells/{aasIdentifier}/submodels/{submodelIdentifier}/submodel-elements/$value: - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/AssetAdministrationShellIdentifier' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/SubmodelIdentifier' - get: - tags: - - Asset Administration Shell Repository API - summary: Returns all submodel elements including their hierarchy in the ValueOnly representation - operationId: GetAllSubmodelElements-ValueOnly_AasRepository - x-semanticIds: - - https://admin-shell.io/aas/API/GetAllSubmodelElements/3/0 - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Limit' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Cursor' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Level' - responses: - '200': - description: List of found submodel elements in their ValueOnly representation - content: - application/json: - schema: - type: array - items: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/GetSubmodelElementsValueResult' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '401': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/unauthorized' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /shells/{aasIdentifier}/submodels/{submodelIdentifier}/submodel-elements/$reference: - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/AssetAdministrationShellIdentifier' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/SubmodelIdentifier' - get: - tags: - - Asset Administration Shell Repository API - summary: Returns all submodel elements as a list of References - operationId: GetAllSubmodelElements-Reference_AasRepository - x-semanticIds: - - https://admin-shell.io/aas/API/GetAllSubmodelElements/3/0 - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Limit' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Cursor' - #- $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Level' - - name: level - in: query - description: Determines the structural depth of the respective resource content - required: false - schema: - type: string - default: core - enum: - # - deep - - core # only 'core' is allowed for Content=Reference - responses: - '200': - description: List of References of the found submodel elements - content: - application/json: - schema: - type: array - items: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/GetReferencesResult' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '401': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/unauthorized' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /shells/{aasIdentifier}/submodels/{submodelIdentifier}/submodel-elements/$path: - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/AssetAdministrationShellIdentifier' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/SubmodelIdentifier' - get: - tags: - - Asset Administration Shell Repository API - summary: Returns all submodel elements including their hierarchy - operationId: GetAllSubmodelElements-Path_AasRepository - x-semanticIds: - - https://admin-shell.io/aas/API/GetAllSubmodelElements/3/0 - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Limit' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Cursor' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Level' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Extent' - responses: - '200': - description: List of found submodel elements in the Path notation - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/GetPathItemsResult' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '401': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/unauthorized' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /shells/{aasIdentifier}/submodels/{submodelIdentifier}/submodel-elements/{idShortPath}: - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/AssetAdministrationShellIdentifier' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/SubmodelIdentifier' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/IdShortPath' - get: - tags: - - Asset Administration Shell Repository API - summary: Returns a specific submodel element from the Submodel at a specified - path - operationId: GetSubmodelElementByPath_AasRepository - x-semanticIds: - - https://admin-shell.io/aas/API/GetSubmodelElementByPath/3/0 - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Limit' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Cursor' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Level' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Extent' - responses: - '200': - description: Requested submodel element - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/GetSubmodelElementsResult' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '401': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/unauthorized' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - post: - tags: - - Asset Administration Shell Repository API - summary: Creates a new submodel element at a specified path within submodel elements hierarchy - operationId: PostSubmodelElementByPath_AasRepository - x-semanticIds: - - https://admin-shell.io/aas/API/PostSubmodelElementByPath/3/0 - requestBody: - description: Requested submodel element - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0#/components/schemas/SubmodelElement' - required: true - responses: - '201': - description: Submodel element created successfully - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0#/components/schemas/SubmodelElement' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '401': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/unauthorized' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '409': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/conflict' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - put: - tags: - - Asset Administration Shell Repository API - summary: Updates an existing submodel element at a specified path within submodel elements hierarchy - operationId: PutSubmodelElementByPath_AasRepository - x-semanticIds: - - https://admin-shell.io/aas/API/PutSubmodelElementByPath/3/0 - - https://admin-shell.io/aas/API/SetSubmodelElementValueByPath/3/0 - requestBody: - description: Requested submodel element - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0#/components/schemas/SubmodelElement' - required: true - responses: - '204': - description: Submodel element updated successfully - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '401': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/unauthorized' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - patch: - tags: - - Asset Administration Shell Repository API - summary: Updates an existing submodel element value at a specified path within submodel elements hierarchy - operationId: PatchSubmodelElementValueByPath_AasRepository - x-semanticIds: - - https://admin-shell.io/aas/API/PatchSubmodelElementByPath/3/0 - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Level' - requestBody: - description: The updated value of the submodel element - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0#/components/schemas/SubmodelElement' - required: true - responses: - '204': - description: Submodel element updated successfully - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '401': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/unauthorized' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - delete: - tags: - - Asset Administration Shell Repository API - summary: Deletes a submodel element at a specified path within the submodel elements hierarchy - operationId: DeleteSubmodelElementByPath_AasRepository - x-semanticIds: - - https://admin-shell.io/aas/API/DeleteSubmodelElementByPath/3/0 - responses: - '204': - description: Submodel element deleted successfully - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '401': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/unauthorized' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /shells/{aasIdentifier}/submodels/{submodelIdentifier}/submodel-elements/{idShortPath}/$metadata: - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/AssetAdministrationShellIdentifier' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/SubmodelIdentifier' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/IdShortPath' - get: - tags: - - Asset Administration Shell Repository API - summary: Returns the metadata attributes if a specific submodel element from the Submodel at a specified - path - operationId: GetSubmodelElementByPath-Metadata_AasRepository - x-semanticIds: - - https://admin-shell.io/aas/API/GetSubmodelElementByPath/3/0 - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Limit' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Cursor' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Level' - responses: - '200': - description: Requested submodel element - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/GetSubmodelElementsMetadataResult' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '401': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/unauthorized' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - patch: - tags: - - Asset Administration Shell Repository API - summary: Updates the metadata attributes of an existing submodel element value at a specified path within submodel elements hierarchy - operationId: PatchSubmodelElementValueByPath-Metadata - x-semanticIds: - - https://admin-shell.io/aas/API/PatchSubmodelElementByPath/3/0 - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Level' - requestBody: - description: The updated metadata attributes of the submodel element - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/SubmodelElementMetadata' - required: true - responses: - '204': - description: Submodel element updated successfully - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '401': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/unauthorized' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /shells/{aasIdentifier}/submodels/{submodelIdentifier}/submodel-elements/{idShortPath}/$value: - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/AssetAdministrationShellIdentifier' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/SubmodelIdentifier' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/IdShortPath' - get: - tags: - - Asset Administration Shell Repository API - summary: Returns a specific submodel element from the Submodel at a specified - path in the ValueOnly representation - operationId: GetSubmodelElementByPath-ValueOnly_AasRepository - x-semanticIds: - - https://admin-shell.io/aas/API/GetSubmodelElementByPath/3/0 - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Limit' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Cursor' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Level' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Extent' - responses: - '200': - description: Requested submodel element in its ValueOnly representation - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/GetSubmodelElementsValueResult' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '401': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/unauthorized' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - patch: - tags: - - Asset Administration Shell Repository API - summary: Updates the value of an existing submodel element value at a specified path within submodel elements hierarchy - operationId: PatchSubmodelElementValueByPath-ValueOnly - x-semanticIds: - - https://admin-shell.io/aas/API/PatchSubmodelElementByPath/3/0 - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Level' - requestBody: - description: The updated value of the submodel element - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/SubmodelElementValue' - required: true - responses: - '204': - description: Submodel element updated successfully - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '401': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/unauthorized' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /shells/{aasIdentifier}/submodels/{submodelIdentifier}/submodel-elements/{idShortPath}/$reference: - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/AssetAdministrationShellIdentifier' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/SubmodelIdentifier' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/IdShortPath' - get: - tags: - - Asset Administration Shell Repository API - summary: Returns the Reference of a specific submodel element from the Submodel at a specified path - operationId: GetSubmodelElementByPath-Reference_AasRepository - x-semanticIds: - - https://admin-shell.io/aas/API/GetSubmodelElementByPath/3/0 - parameters: - #- $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Level' - - name: level - in: query - description: Determines the structural depth of the respective resource content - required: false - schema: - type: string - default: core - enum: - # - deep - - core # only 'core' is allowed for Content=Reference - responses: - '200': - description: Requested submodel element in its ValueOnly representation - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0#/components/schemas/Reference' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '401': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/unauthorized' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /shells/{aasIdentifier}/submodels/{submodelIdentifier}/submodel-elements/{idShortPath}/$path: - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/AssetAdministrationShellIdentifier' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/SubmodelIdentifier' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/IdShortPath' - get: - tags: - - Asset Administration Shell Repository API - summary: Returns a specific submodel element from the Submodel at a specified path in the Path notation - operationId: GetSubmodelElementByPath-Path_AasRepository - x-semanticIds: - - https://admin-shell.io/aas/API/GetSubmodelElementByPath/3/0 - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Level' - responses: - '200': - description: Requested submodel element in the Path notation - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/PathItem' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '401': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/unauthorized' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /shells/{aasIdentifier}/submodels/{submodelIdentifier}/submodel-elements/{idShortPath}/attachment: - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/AssetAdministrationShellIdentifier' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/SubmodelIdentifier' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/IdShortPath' - get: - tags: - - Asset Administration Shell Repository API - summary: Downloads file content from a specific submodel element from the Submodel at a specified path - operationId: GetFileByPath_AasRepository - x-semanticIds: - - https://admin-shell.io/aas/API/GetFileByPath/3/0 - responses: - '200': - description: Requested file - headers: - Content-Disposition: - schema: - type: string - description: In order to physically download the file usually set to attachment with a filename - example: 'attachment; filename="filename.jpg"' - content: - application/octet-stream: - schema: - type: string - format: binary - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '401': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/unauthorized' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - put: - tags: - - Asset Administration Shell Repository API - summary: Uploads file content to an existing submodel element at a specified path within submodel elements hierarchy - operationId: PutFileByPath_AasRepository - x-semanticIds: - - https://admin-shell.io/aas/API/PutFileByPath/3/0 - requestBody: - description: File to upload - content: - multipart/form-data: - schema: - type: object - properties: - fileName: - type: string - file: - type: string - format: binary - encoding: - file: - contentType: application/octet-stream - required: true - responses: - '204': - description: Submodel element updated successfully - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '401': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/unauthorized' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - delete: - tags: - - Asset Administration Shell Repository API - summary: Deletes file content of an existing submodel element at a specified path within submodel elements hierarchy - operationId: DeleteFileByPath_AasRepository - x-semanticIds: - - https://admin-shell.io/aas/API/DeleteFileByPath/3/0 - responses: - '200': - description: Submodel element updated successfully - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '401': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/unauthorized' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /shells/{aasIdentifier}/submodels/{submodelIdentifier}/submodel-elements/{idShortPath}/invoke: - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/AssetAdministrationShellIdentifier' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/SubmodelIdentifier' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/IdShortPath' - post: - tags: - - Asset Administration Shell Repository API - summary: Synchronously invokes an Operation at a specified path - operationId: InvokeOperation_AasRepository - x-semanticIds: - - https://admin-shell.io/aas/API/InvokeOperationSync/3/0 - requestBody: - description: Operation request object - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/OperationRequest' - required: true - responses: - '200': - description: Operation result object - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/OperationResult' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '401': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/unauthorized' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /shells/{aasIdentifier}/submodels/{submodelIdentifier}/submodel-elements/{idShortPath}/invoke/$value: - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/AssetAdministrationShellIdentifier' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/SubmodelIdentifier' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/IdShortPath' - post: - tags: - - Asset Administration Shell Repository API - summary: Synchronously invokes an Operation at a specified path - operationId: InvokeOperation-ValueOnly_AasRepository - x-semanticIds: - - https://admin-shell.io/aas/API/InvokeOperationSync/3/0 - requestBody: - description: Operation request object - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/OperationRequestValueOnly' - required: true - responses: - '200': - description: Operation result object - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/OperationResultValueOnly' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '401': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/unauthorized' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /shells/{aasIdentifier}/submodels/{submodelIdentifier}/submodel-elements/{idShortPath}/invoke-async: - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/AssetAdministrationShellIdentifier' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/SubmodelIdentifier' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/IdShortPath' - post: - tags: - - Asset Administration Shell Repository API - summary: Asynchronously invokes an Operation at a specified path - operationId: InvokeOperationAsync_AasRepository - x-semanticIds: - - https://admin-shell.io/aas/API/InvokeOperationAsync/3/0 - requestBody: - description: Operation request object - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/OperationRequest' - required: true - responses: - '202': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/accepted' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '401': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/unauthorized' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /shells/{aasIdentifier}/submodels/{submodelIdentifier}/submodel-elements/{idShortPath}/invoke-async/$value: - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/AssetAdministrationShellIdentifier' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/SubmodelIdentifier' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/IdShortPath' - post: - tags: - - Asset Administration Shell Repository API - summary: Asynchronously invokes an Operation at a specified path - operationId: InvokeOperationAsync-ValueOnly_AasRepository - x-semanticIds: - - https://admin-shell.io/aas/API/InvokeOperationAsync/3/0 - requestBody: - description: Operation request object - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/OperationRequestValueOnly' - required: true - responses: - '202': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/accpeted' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '401': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/unauthorized' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /shells/{aasIdentifier}/submodels/{submodelIdentifier}/submodel-elements/{idShortPath}/operation-results/{handleId}: - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/AssetAdministrationShellIdentifier' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/SubmodelIdentifier' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/IdShortPath' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/HandleId' - get: - tags: - - Asset Administration Shell Repository API - summary: Returns the Operation result of an asynchronous invoked Operation - operationId: GetOperationAsyncResult_AasRepository - x-semanticIds: - - https://admin-shell.io/aas/API/GetOperationAsyncResult/3/0 - responses: - '200': - description: Operation result object - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/OperationResult' - '302': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/found' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '401': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/unauthorized' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /shells/{aasIdentifier}/submodels/{submodelIdentifier}/submodel-elements/{idShortPath}/operation-results/{handleId}/$value: - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/AssetAdministrationShellIdentifier' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/SubmodelIdentifier' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/IdShortPath' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/HandleId' - get: - tags: - - Asset Administration Shell Repository API - summary: Returns the ValueOnly notation of the Operation result of an asynchronous invoked Operation - operationId: GetOperationAsyncResult-ValueOnly_AasRepository - x-semanticIds: - - https://admin-shell.io/aas/API/GetOperationAsyncResult/3/0 - responses: - '200': - description: Operation result object - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/OperationResultValueOnly' - '302': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/found' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '401': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/unauthorized' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - - /submodels: - get: - tags: - - Submodel Repository API - summary: Returns all Submodels - operationId: GetAllSubmodels - x-semanticIds: - - https://admin-shell.io/aas/API/GetAllSubmodels/3/0 - - https://admin-shell.io/aas/API/GetAllSubmodelsBySemanticId/3/0 - - https://admin-shell.io/aas/API/GetAllSubmodelsByIdShort/3/0 - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/SemanticId' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/IdShort' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Limit' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Cursor' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Level' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Extent' - responses: - '200': - description: Requested Submodels - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/GetSubmodelsResult' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '401': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/unauthorized' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - post: - tags: - - Submodel Repository API - summary: Creates a new Submodel - operationId: PostSubmodel - x-semanticIds: - - https://admin-shell.io/aas/API/PostSubmodel/3/0 - requestBody: - description: Submodel object - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0#/components/schemas/Submodel' - required: true - responses: - '201': - description: Submodel created successfully - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0#/components/schemas/Submodel' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '401': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/unauthorized' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '409': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/conflict' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /submodels/$metadata: - get: - tags: - - Submodel Repository API - summary: Returns the metadata attributes of all Submodels - operationId: GetAllSubmodels-Metadata - x-semanticIds: - - https://admin-shell.io/aas/API/GetAllSubmodels/3/0 - - https://admin-shell.io/aas/API/GetAllSubmodelsBySemanticId/3/0 - - https://admin-shell.io/aas/API/GetAllSubmodelsByIdShort/3/0 - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/SemanticId' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/IdShort' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Limit' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Cursor' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Level' - responses: - '200': - description: Requested Submodels - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/GetSubmodelsMetadataResult' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '401': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/unauthorized' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /submodels/$value: - get: - tags: - - Submodel Repository API - summary: Returns all Submodels in their ValueOnly representation - operationId: GetAllSubmodels-ValueOnly - x-semanticIds: - - https://admin-shell.io/aas/API/GetAllSubmodels/3/0 - - https://admin-shell.io/aas/API/GetAllSubmodelsBySemanticId/3/0 - - https://admin-shell.io/aas/API/GetAllSubmodelsByIdShort/3/0 - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/SemanticId' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/IdShort' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Limit' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Cursor' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Level' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Extent' - responses: - '200': - description: Requested Submodels - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/GetSubmodelsValueResult' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '401': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/unauthorized' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /submodels/$reference: - get: - tags: - - Submodel Repository API - summary: Returns the References for all Submodels - operationId: GetAllSubmodels-Reference - x-semanticIds: - - https://admin-shell.io/aas/API/GetAllSubmodels/3/0 - - https://admin-shell.io/aas/API/GetAllSubmodelsBySemanticId/3/0 - - https://admin-shell.io/aas/API/GetAllSubmodelsByIdShort/3/0 - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/SemanticId' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/IdShort' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Limit' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Cursor' - #- $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Level' - - name: level - in: query - description: Determines the structural depth of the respective resource content - required: false - schema: - type: string - default: core - enum: - # - deep - - core # only 'core' is allowed for Content=Reference - responses: - '200': - description: References of the requested Submodels - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/GetReferencesResult' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '401': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/unauthorized' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /submodels/$path: - get: - tags: - - Submodel Repository API - summary: Returns all Submodels in the Path notation - operationId: GetAllSubmodels-Path - x-semanticIds: - - https://admin-shell.io/aas/API/GetAllSubmodels/3/0 - - https://admin-shell.io/aas/API/GetAllSubmodelsBySemanticId/3/0 - - https://admin-shell.io/aas/API/GetAllSubmodelsByIdShort/3/0 - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/SemanticId' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/IdShort' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Limit' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Cursor' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Level' - responses: - '200': - description: Requested Submodels - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/GetPathItemsResult' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '401': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/unauthorized' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /submodels/{submodelIdentifier}: - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/SubmodelIdentifier' - get: - tags: - - Submodel Repository API - summary: Returns a specific Submodel - operationId: GetSubmodelById - x-semanticIds: - - https://admin-shell.io/aas/API/GetSubmodelById/3/0 - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Level' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Extent' - responses: - '200': - description: Requested Submodel - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0#/components/schemas/Submodel' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '401': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/unauthorized' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - put: - tags: - - Submodel Repository API - summary: Updates an existing Submodel - operationId: PutSubmodelById - x-semanticIds: - - https://admin-shell.io/aas/API/PutSubmodelById/3/0 - parameters: - #- $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Level' - - name: level - in: query - description: Determines the structural depth of the respective resource content - required: false - schema: - type: string - default: deep - enum: - - deep # only 'deep' is allowed for PUT - #- core - requestBody: - description: Submodel object - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0#/components/schemas/Submodel' - required: true - responses: - '204': - description: Submodel updated successfully - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '401': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/unauthorized' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - patch: - tags: - - Submodel Repository API - summary: Updates an existing Submodel - operationId: PatchSubmodelById - x-semanticIds: - - https://admin-shell.io/aas/API/PatchSubmodelById/3/0 - parameters: - #- $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Level' - - name: level - in: query - description: Determines the structural depth of the respective resource content - required: false - schema: - type: string - default: core - enum: - #- deep - - core # only 'core' is allowed for PATCH - requestBody: - description: Submodel object - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0#/components/schemas/Submodel' - required: true - responses: - '204': - description: Submodel updated successfully - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '401': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/unauthorized' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - delete: - tags: - - Submodel Repository API - summary: Deletes a Submodel - operationId: DeleteSubmodelById - x-semanticIds: - - https://admin-shell.io/aas/API/DeleteSubmodelById/3/0 - responses: - '204': - description: Submodel deleted successfully - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '401': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/unauthorized' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /submodels/{submodelIdentifier}/$metadata: - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/SubmodelIdentifier' - get: - tags: - - Submodel Repository API - summary: Returns the metadata attributes of a specific Submodel - operationId: GetSubmodelById-Metadata - x-semanticIds: - - https://admin-shell.io/aas/API/GetSubmodelById/3/0 - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Level' - responses: - '200': - description: Requested Submodel in the metadata representation - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/SubmodelMetadata' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '401': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/unauthorized' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - patch: - tags: - - Submodel Repository API - summary: Updates the metadata attributes of an existing Submodel - operationId: PatchSubmodelById-Metadata - x-semanticIds: - - https://admin-shell.io/aas/API/PatchSubmodelById/3/0 - parameters: - #- $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Level' - - name: level - in: query - description: Determines the structural depth of the respective resource content - required: false - schema: - type: string - default: core - enum: - #- deep - - core # only 'core' is allowed for PATCH - requestBody: - description: The metadata attributes of the Submodel object - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/SubmodelMetadata' - required: true - responses: - '204': - description: Submodel updated successfully - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '401': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/unauthorized' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /submodels/{submodelIdentifier}/$value: - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/SubmodelIdentifier' - get: - tags: - - Submodel Repository API - summary: Returns a specific Submodel in the ValueOnly representation - operationId: GetSubmodelById-ValueOnly - x-semanticIds: - - https://admin-shell.io/aas/API/GetSubmodelById/3/0 - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Level' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Extent' - responses: - '200': - description: Requested Submodel - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/SubmodelValue' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '401': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/unauthorized' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - patch: - tags: - - Submodel Repository API - summary: Updates the values of an existing Submodel - operationId: PatchSubmodelById-ValueOnly - x-semanticIds: - - https://admin-shell.io/aas/API/PatchSubmodelById/3/0 - parameters: - #- $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Level' - - name: level - in: query - description: Determines the structural depth of the respective resource content - required: false - schema: - type: string - default: core - enum: - #- deep - - core # only 'core' is allowed for PATCH - requestBody: - description: Submodel object in its ValueOnly representation - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/SubmodelValue' - required: true - responses: - '204': - description: Submodel updated successfully - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '401': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/unauthorized' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /submodels/{submodelIdentifier}/$reference: - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/SubmodelIdentifier' - get: - tags: - - Submodel Repository API - summary: Returns the Reference of a specific Submodel - operationId: GetSubmodelById-Reference - x-semanticIds: - - https://admin-shell.io/aas/API/GetSubmodelById/3/0 - parameters: - #- $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Level' - - name: level - in: query - description: Determines the structural depth of the respective resource content - required: false - schema: - type: string - default: core - enum: - # - deep - - core # only 'core' is allowed for Content=Reference - responses: - '200': - description: Requested Submodel - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0#/components/schemas/Reference' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '401': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/unauthorized' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /submodels/{submodelIdentifier}/$path: - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/SubmodelIdentifier' - get: - tags: - - Submodel Repository API - summary: Returns a specific Submodel in the Path notation - operationId: GetSubmodelById-Path - x-semanticIds: - - https://admin-shell.io/aas/API/GetSubmodelById/3/0 - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Level' - responses: - '200': - description: Requested Submodel - content: - application/json: - schema: - type: array - items: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/PathItem' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '401': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/unauthorized' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /submodels/{submodelIdentifier}/submodel-elements: - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/SubmodelIdentifier' - get: - tags: - - Submodel Repository API - summary: Returns all submodel elements including their hierarchy - operationId: GetAllSubmodelElements_SubmodelRepository - x-semanticIds: - - https://admin-shell.io/aas/API/GetAllSubmodelElements/3/0 - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Limit' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Cursor' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Level' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Extent' - responses: - '200': - description: List of found submodel elements - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/GetSubmodelElementsResult' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '401': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/unauthorized' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - description: Default error handling for unmentioned status codes - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/Result' - post: - tags: - - Submodel Repository API - summary: Creates a new submodel element - operationId: PostSubmodelElement_SubmodelRepository - x-semanticIds: - - https://admin-shell.io/aas/API/PostSubmodelElement/3/0 - requestBody: - description: Requested submodel element - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0#/components/schemas/SubmodelElement' - required: true - responses: - '201': - description: Submodel element created successfully - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0#/components/schemas/SubmodelElement' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '401': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/unauthorized' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '409': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/conflict' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /submodels/{submodelIdentifier}/submodel-elements/$metadata: - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/SubmodelIdentifier' - get: - tags: - - Submodel Repository API - summary: Returns the metadata attributes of all submodel elements including their hierarchy - operationId: GetAllSubmodelElements-Metadata_SubmodelRepository - x-semanticIds: - - https://admin-shell.io/aas/API/GetAllSubmodelElements/3/0 - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Limit' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Cursor' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Level' - responses: - '200': - description: List of found submodel elements - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/GetSubmodelElementsMetadataResult' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '401': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/unauthorized' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /submodels/{submodelIdentifier}/submodel-elements/$value: - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/SubmodelIdentifier' - get: - tags: - - Submodel Repository API - summary: Returns all submodel elements including their hierarchy in the ValueOnly representation - operationId: GetAllSubmodelElements-ValueOnly_SubmodelRepo # TODO - x-semanticIds: - - https://admin-shell.io/aas/API/GetAllSubmodelElements/3/0 - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Limit' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Cursor' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Level' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Extent' - responses: - '200': - description: List of found submodel elements - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/GetSubmodelElementsValueResult' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '401': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/unauthorized' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /submodels/{submodelIdentifier}/submodel-elements/$reference: - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/SubmodelIdentifier' - get: - tags: - - Submodel Repository API - summary: Returns the References of all submodel elements - operationId: GetAllSubmodelElements-Reference_SubmodelRepo # TODO - x-semanticIds: - - https://admin-shell.io/aas/API/GetAllSubmodelElements/3/0 - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Limit' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Cursor' - #- $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Level' - - name: level - in: query - description: Determines the structural depth of the respective resource content - required: false - schema: - type: string - default: core - enum: - # - deep - - core # only 'core' is allowed for Content=Reference - responses: - '200': - description: List of found submodel elements - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/GetReferencesResult' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '401': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/unauthorized' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /submodels/{submodelIdentifier}/submodel-elements/$path: - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/SubmodelIdentifier' - get: - tags: - - Submodel Repository API - summary: Returns all submodel elements including their hierarchy in the Path notation - operationId: GetAllSubmodelElements-Path_SubmodelRepo # TODO - x-semanticIds: - - https://admin-shell.io/aas/API/GetAllSubmodelElements/3/0 - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Limit' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Cursor' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Level' - responses: - '200': - description: List of found submodel elements in the Path notation - content: - application/json: - schema: - type: array - items: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/GetPathItemsResult' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '401': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/unauthorized' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /submodels/{submodelIdentifier}/submodel-elements/{idShortPath}: - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/SubmodelIdentifier' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/IdShortPath' - get: - tags: - - Submodel Repository API - summary: Returns a specific submodel element from the Submodel at a specified - path - operationId: GetSubmodelElementByPath_SubmodelRepo # TODO - x-semanticIds: - - https://admin-shell.io/aas/API/GetSubmodelElementByPath/3/0 - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Level' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Extent' - responses: - '200': - description: Requested submodel element - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0#/components/schemas/SubmodelElement' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '401': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/unauthorized' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - post: - tags: - - Submodel Repository API - summary: Creates a new submodel element at a specified path within submodel elements hierarchy - operationId: PostSubmodelElementByPath_SubmodelRepo # TODO - x-semanticIds: - - https://admin-shell.io/aas/API/PostSubmodelElementByPath/3/0 - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Level' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Extent' - requestBody: - description: Requested submodel element - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0#/components/schemas/SubmodelElement' - required: true - responses: - '201': - description: Submodel element created successfully - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0#/components/schemas/SubmodelElement' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '401': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/unauthorized' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '409': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/conflict' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - put: - tags: - - Submodel Repository API - summary: Updates an existing submodel element at a specified path within submodel elements hierarchy - operationId: PutSubmodelElementByPath_SubmodelRepo # TODO - x-semanticIds: - - https://admin-shell.io/aas/API/PutSubmodelElementByPath/3/0 - - https://admin-shell.io/aas/API/SetSubmodelElementValueByPath/3/0 - parameters: - #- $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Level' - - name: level - in: query - description: Determines the structural depth of the respective resource content - required: false - schema: - type: string - default: deep - enum: - - deep # only 'deep' is allowed for PUT - #- core - requestBody: - description: Requested submodel element - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0#/components/schemas/SubmodelElement' - required: true - responses: - '204': - description: Submodel element updated successfully - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '401': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/unauthorized' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - patch: - tags: - - Submodel Repository API - summary: Updates an existing SubmodelElement - operationId: PatchSubmodelElementByPath_SubmodelRepo # TODO - x-semanticIds: - - https://admin-shell.io/aas/API/PatchSubmodelById/3/0 - parameters: - #- $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Level' - - name: level - in: query - description: Determines the structural depth of the respective resource content - required: false - schema: - type: string - default: core - enum: - #- deep - - core # only 'core' is allowed for PATCH - requestBody: - description: SubmodelElement object - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0#/components/schemas/SubmodelElement' - required: true - responses: - '204': - description: SubmodelElement updated successfully - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '401': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/unauthorized' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - delete: - tags: - - Submodel Repository API - summary: Deletes a submodel element at a specified path within the submodel elements hierarchy - operationId: DeleteSubmodelElementByPath_SubmodelRepo # TODO - x-semanticIds: - - https://admin-shell.io/aas/API/DeleteSubmodelElementByPath/3/0 - responses: - '204': - description: Submodel element deleted successfully - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '401': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/unauthorized' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /submodels/{submodelIdentifier}/submodel-elements/{idShortPath}/$metadata: - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/SubmodelIdentifier' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/IdShortPath' - get: - tags: - - Submodel Repository API - summary: Returns the matadata attributes of a specific submodel element from the Submodel at a specified - path - operationId: GetSubmodelElementByPath-Metadata_SubmodelRepo # TODO - x-semanticIds: - - https://admin-shell.io/aas/API/GetSubmodelElementByPath/3/0 - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Level' - responses: - '200': - description: Metadata attributes of the requested submodel element - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/SubmodelElementMetadata' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '401': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/unauthorized' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - patch: - tags: - - Submodel Repository API - summary: Updates the metadata attributes an existing SubmodelElement - operationId: PatchSubmodelElementByPath-Metadata_SubmodelRepo # TODO - x-semanticIds: - - https://admin-shell.io/aas/API/PatchSubmodelElementByPath/3/0 - parameters: - #- $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Level' - - name: level - in: query - description: Determines the structural depth of the respective resource content - required: false - schema: - type: string - default: core - enum: - #- deep - - core # only 'core' is allowed for PATCH - requestBody: - description: Metadata attributes of the SubmodelElement - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/SubmodelElementMetadata' - required: true - responses: - '204': - description: SubmodelElement updated successfully - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '401': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/unauthorized' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /submodels/{submodelIdentifier}/submodel-elements/{idShortPath}/$value: - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/SubmodelIdentifier' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/IdShortPath' - get: - tags: - - Submodel Repository API - summary: Returns a specific submodel element from the Submodel at a specified - path in the ValueOnly representation - operationId: GetSubmodelElementByPath-ValueOnly_SubmodelRepo # TODO - x-semanticIds: - - https://admin-shell.io/aas/API/GetSubmodelElementByPath/3/0 - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Level' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Extent' - responses: - '200': - description: Requested submodel element - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/SubmodelElementValue' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '401': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/unauthorized' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - patch: - tags: - - Submodel Repository API - summary: Updates the value of an existing SubmodelElement - operationId: PatchSubmodelElementByPath-ValueOnly_SubmodelRepo # TODO - x-semanticIds: - - https://admin-shell.io/aas/API/PatchSubmodelElementByPath/3/0 - parameters: - #- $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Level' - - name: level - in: query - description: Determines the structural depth of the respective resource content - required: false - schema: - type: string - default: core - enum: - #- deep - - core # only 'core' is allowed for PATCH - requestBody: - description: The SubmodelElement in its ValueOnly representation - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/SubmodelElementValue' - required: true - responses: - '204': - description: Submodel updated successfully - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '401': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/unauthorized' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /submodels/{submodelIdentifier}/submodel-elements/{idShortPath}/$reference: - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/SubmodelIdentifier' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/IdShortPath' - get: - tags: - - Submodel Repository API - summary: Returns the Referene of a specific submodel element from the Submodel at a specified - path - operationId: GetSubmodelElementByPath-Reference_SubmodelRepo # TODO - x-semanticIds: - - https://admin-shell.io/aas/API/GetSubmodelElementByPath/3/0 - parameters: - #- $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Level' - - name: level - in: query - description: Determines the structural depth of the respective resource content - required: false - schema: - type: string - default: core - enum: - # - deep - - core # only 'core' is allowed for Content=Reference - responses: - '200': - description: Requested submodel element - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0#/components/schemas/Reference' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '401': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/unauthorized' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /submodels/{submodelIdentifier}/submodel-elements/{idShortPath}/$path: - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/SubmodelIdentifier' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/IdShortPath' - get: - tags: - - Submodel Repository API - summary: Returns a specific submodel element from the Submodel at a specified - path in the Path notation - operationId: GetSubmodelElementByPath-Path_SubmodelRepo # TODO - x-semanticIds: - - https://admin-shell.io/aas/API/GetSubmodelElementByPath/3/0 - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Level' - responses: - '200': - description: Requested submodel element - content: - application/json: - schema: - type: array - items: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/PathItem' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '401': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/unauthorized' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /submodels/{submodelIdentifier}/submodel-elements/{idShortPath}/attachment: - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/SubmodelIdentifier' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/IdShortPath' - get: - tags: - - Submodel Repository API - summary: Downloads file content from a specific submodel element from the Submodel at a specified path - operationId: GetFileByPath_SubmodelRepo # TODO - x-semanticIds: - - https://admin-shell.io/aas/API/GetFileByPath/3/0 - responses: - '200': - description: Requested file - headers: - Content-Disposition: - schema: - type: string - description: In order to physically download the file usually set to attachment with a filename - example: 'attachment; filename="filename.jpg"' - content: - application/octet-stream: - schema: - type: string - format: binary - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '401': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/unauthorized' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '405': - description: Method not allowed - Download only valid for File submodel element - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/Result' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - put: - tags: - - Submodel Repository API - summary: Uploads file content to an existing submodel element at a specified path within submodel elements hierarchy - operationId: PutFileByPath_SubmodelRepo # TODO - x-semanticIds: - - https://admin-shell.io/aas/API/PutFileByPath/3/0 - requestBody: - description: File to upload - content: - multipart/form-data: - schema: - type: object - properties: - fileName: - type: string - file: - type: string - format: binary - encoding: - file: - contentType: application/octet-stream - required: true - responses: - '204': - description: Submodel element updated successfully - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '401': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/unauthorized' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '405': - description: Method not allowed - Upload only valid for File submodel element - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/Result' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - delete: - tags: - - Submodel Repository API - summary: Deletes file content of an existing submodel element at a specified path within submodel elements hierarchy - operationId: DeleteFileByPath_SubmodelRepo # TODO - x-semanticIds: - - https://admin-shell.io/aas/API/DeleteFileByPath/3/0 - responses: - '200': - description: Submodel element updated successfully - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '401': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/unauthorized' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /submodels/{submodelIdentifier}/submodel-elements/{idShortPath}/invoke: - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/SubmodelIdentifier' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/IdShortPath' - post: - tags: - - Submodel Repository API - summary: Synchronously or asynchronously invokes an Operation at a specified path - operationId: InvokeOperation_SubmodelRepo # TODO - x-semanticIds: - - https://admin-shell.io/aas/API/InvokeOperationSync/3/0 - - https://admin-shell.io/aas/API/InvokeOperationAsync/3/0 - parameters: - - name: async - in: query - description: Determines whether an operation invocation is performed asynchronously or synchronously - schema: - type: boolean - default: false - requestBody: - description: Operation request object - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/OperationRequest' - required: true - responses: - '200': - description: Operation result object - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/OperationResult' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '401': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/unauthorized' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '405': - description: Method not allowed - Invoke only valid for Operation submodel element - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/Result' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /submodels/{submodelIdentifier}/submodel-elements/{idShortPath}/invoke/$value: - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/AssetAdministrationShellIdentifier' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/SubmodelIdentifier' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/IdShortPath' - post: - tags: - - Submodel Repository API - summary: Synchronously or asynchronously invokes an Operation at a specified path - operationId: InvokeOperation-ValueOnly_SubmodelRepo # TODO - x-semanticIds: - - https://admin-shell.io/aas/API/InvokeOperationSync/3/0 - - https://admin-shell.io/aas/API/InvokeOperationAsync/3/0 - parameters: - - name: async - in: query - description: Determines whether an operation invocation is performed asynchronously or synchronously - schema: - type: boolean - default: false - requestBody: - description: Operation request object - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/OperationRequestValueOnly' - required: true - responses: - '200': - description: Operation result object - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/OperationResultValueOnly' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '401': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/unauthorized' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - - /submodels/{submodelIdentifier}/submodel-elements/{idShortPath}/invoke-async: - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/SubmodelIdentifier' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/IdShortPath' - post: - tags: - - Submodel Repository API - summary: Asynchronously invokes an Operation at a specified path - operationId: InvokeOperationAsync_SubmodelRepo # TODO - x-semanticIds: - - https://admin-shell.io/aas/API/InvokeOperationAsync/3/0 - requestBody: - description: Operation request object - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/OperationRequest' - required: true - responses: - '202': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/accepted' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '401': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/unauthorized' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '405': - description: Method not allowed - Invoke only valid for Operation submodel element - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/Result' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /submodels/{submodelIdentifier}/submodel-elements/{idShortPath}/invoke-async/$value: - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/AssetAdministrationShellIdentifier' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/SubmodelIdentifier' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/IdShortPath' - post: - tags: - - Submodel Repository API - summary: Asynchronously invokes an Operation at a specified path - operationId: InvokeOperationAsync-ValueOnly_SubmodelRepo # TODO - x-semanticIds: - - https://admin-shell.io/aas/API/InvokeOperationAsync/3/0 - requestBody: - description: Operation request object - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/OperationRequestValueOnly' - required: true - responses: - '202': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/accepted' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '401': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/unauthorized' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /submodels/{submodelIdentifier}/submodel-elements/{idShortPath}/operation-results/{handleId}: - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/SubmodelIdentifier' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/IdShortPath' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/HandleId' - get: - tags: - - Submodel Repository API - summary: Returns the Operation result of an asynchronous invoked Operation - operationId: GetOperationAsyncResult_SubmodelRepo # TODO - x-semanticIds: - - https://admin-shell.io/aas/API/GetOperationAsyncResult/3/0 - responses: - '200': - description: Operation result object - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/OperationResult' - '302': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/found' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '401': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/unauthorized' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /submodels/{submodelIdentifier}/submodel-elements/{idShortPath}/operation-results/{handleId}/$value: - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/SubmodelIdentifier' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/IdShortPath' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/HandleId' - get: - tags: - - Submodel Repository API - summary: Returns the Operation result of an asynchronous invoked Operation - operationId: GetOperationAsyncResult-ValueOnly_SubmodelRepo # TODO - x-semanticIds: - - https://admin-shell.io/aas/API/GetOperationAsyncResult/3/0 - responses: - '200': - description: Value of the operation result object - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/OperationResultValueOnly' - '302': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/found' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '401': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/unauthorized' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - - - /concept-descriptions: - get: - tags: - - Concept Description Repository API - summary: Returns all Concept Descriptions - operationId: GetAllConceptDescriptions - x-semanticIds: - - https://admin-shell.io/aas/API/GetAllConceptDescriptions/3/0 - - https://admin-shell.io/aas/API/GetAllConceptDescriptionsByIdShort/3/0 - - https://admin-shell.io/aas/API/GetAllConceptDescriptionsByIsCaseOf/3/0 - - https://admin-shell.io/aas/API/GetAllConceptDescriptionsByDataSpecificationReference/3/0 - parameters: - - name: idShort - in: query - description: The Concept Description’s IdShort - required: false - style: form - explode: true - schema: - type: string - - name: isCaseOf - in: query - description: IsCaseOf reference (UTF8-BASE64-URL-encoded) - required: false - style: form - explode: true - schema: - type: string - format: byte - - name: dataSpecificationRef - in: query - description: DataSpecification reference (UTF8-BASE64-URL-encoded) - required: false - style: form - explode: true - schema: - type: string - format: byte - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Limit' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Cursor' - responses: - '200': - description: Requested Concept Descriptions - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/GetConceptDescriptionsResult' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - post: - tags: - - Concept Description Repository API - summary: Creates a new Concept Description - operationId: PostConceptDescription - x-semanticIds: - - https://admin-shell.io/aas/API/PostConceptDescription/3/0 - requestBody: - description: Concept Description object - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0#/components/schemas/ConceptDescription' - required: true - responses: - '201': - description: Concept Description created successfully - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0#/components/schemas/ConceptDescription' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '409': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/conflict' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /concept-descriptions/{cdIdentifier}: - get: - tags: - - Concept Description Repository API - summary: Returns a specific Concept Description - operationId: GetConceptDescriptionById - x-semanticIds: - - https://admin-shell.io/aas/API/GetConceptDescriptionById/3/0 - parameters: - - name: cdIdentifier - in: path - description: The Concept Description’s unique id (UTF8-BASE64-URL-encoded) - required: true - style: simple - explode: true - schema: - type: string - format: byte - responses: - '200': - description: Requested Concept Description - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0#/components/schemas/ConceptDescription' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - put: - tags: - - Concept Description Repository API - summary: Updates an existing Concept Description - operationId: PutConceptDescriptionById - x-semanticIds: - - https://admin-shell.io/aas/API/PutConceptDescriptionById/3/0 - parameters: - - name: cdIdentifier - in: path - description: The Concept Description’s unique id (UTF8-BASE64-URL-encoded) - required: true - style: simple - explode: false - schema: - type: string - format: byte - requestBody: - description: Concept Description object - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0#/components/schemas/ConceptDescription' - required: true - responses: - '204': - description: Concept Description updated successfully - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - delete: - tags: - - Concept Description Repository API - summary: Deletes a Concept Description - operationId: DeleteConceptDescriptionById - x-semanticIds: - - https://admin-shell.io/aas/API/DeleteConceptDescriptionById/3/0 - parameters: - - name: cdIdentifier - in: path - description: The Concept Description’s unique id (UTF8-BASE64-URL-encoded) - required: true - style: simple - explode: false - schema: - type: string - format: byte - responses: - '204': - description: Concept Description deleted successfully - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - - - - - - /shell-descriptors: - get: - tags: - - Asset Administration Shell Registry API - summary: Returns all Asset Administration Shell Descriptors - operationId: GetAllAssetAdministrationShellDescriptors - x-semanticIds: - - https://admin-shell.io/aas/API/GetAllAssetAdministrationShellDescriptors/3/0 - - https://admin-shell.io/aas/API/GetAllAssetAdministrationShellDescriptorsByAssetKind/3/0 - - https://admin-shell.io/aas/API/GetAllAssetAdministrationShellDescriptorsByAssetType/3/0 - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Limit' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Cursor' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/AssetKind' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/AssetType' - responses: - '200': - description: Requested Asset Administration Shell Descriptors - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/GetAssetAdministrationShellDescriptorsResult' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - post: - tags: - - Asset Administration Shell Registry API - summary: Creates a new Asset Administration Shell Descriptor, i.e. registers an AAS - operationId: PostAssetAdministrationShellDescriptor - x-semanticIds: - - https://admin-shell.io/aas/API/PostAssetAdministrationShellDescriptor/3/0 - requestBody: - description: Asset Administration Shell Descriptor object - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/AssetAdministrationShellDescriptor' - required: true - responses: - '201': - description: Asset Administration Shell Descriptor created successfully - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/AssetAdministrationShellDescriptor' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '409': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/conflict' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /shell-descriptors/{aasIdentifier}: - get: - tags: - - Asset Administration Shell Registry API - summary: Returns a specific Asset Administration Shell Descriptor - operationId: GetAssetAdministrationShellDescriptorById - x-semanticIds: - - https://admin-shell.io/aas/API/GetAssetAdministrationShellDescriptorById/3/0 - parameters: - - name: aasIdentifier - in: path - description: The Asset Administration Shell’s unique id (UTF8-BASE64-URL-encoded) - required: true - style: simple - explode: false - schema: - type: string - format: byte - responses: - '200': - description: Requested Asset Administration Shell Descriptor - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/AssetAdministrationShellDescriptor' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - put: - tags: - - Asset Administration Shell Registry API - summary: Updates an existing Asset Administration Shell Descriptor - operationId: PutAssetAdministrationShellDescriptorById - x-semanticIds: - - https://admin-shell.io/aas/API/PutAssetAdministrationShellDescriptorById/3/0 - parameters: - - name: aasIdentifier - in: path - description: The Asset Administration Shell’s unique id (UTF8-BASE64-URL-encoded) - required: true - style: simple - explode: false - schema: - type: string - format: byte - requestBody: - description: Asset Administration Shell Descriptor object - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/AssetAdministrationShellDescriptor' - required: true - responses: - '204': - description: Asset Administration Shell Descriptor updated successfully - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - delete: - tags: - - Asset Administration Shell Registry API - summary: Deletes an Asset Administration Shell Descriptor, i.e. de-registers an AAS - operationId: DeleteAssetAdministrationShellDescriptorById - x-semanticIds: - - https://admin-shell.io/aas/API/DeleteAssetAdministrationShellDescriptorById/3/0 - parameters: - - name: aasIdentifier - in: path - description: The Asset Administration Shell’s unique id (UTF8-BASE64-URL-encoded) - required: true - style: simple - explode: false - schema: - type: string - format: byte - responses: - '204': - description: Asset Administration Shell Descriptor deleted successfully - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /shell-descriptors/{aasIdentifier}/submodel-descriptors: - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/AssetAdministrationShellIdentifier' - get: - tags: - - Asset Administration Shell Registry API - summary: Returns all Submodel Descriptors - operationId: GetAllSubmodelDescriptorsThroughSuperpath - x-semanticIds: - - https://admin-shell.io/aas/API/GetAllSubmodelDescriptors/3/0 - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Limit' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Cursor' - responses: - '200': - description: Requested Submodel Descriptors - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/GetSubmodelDescriptorsResult' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - post: - tags: - - Asset Administration Shell Registry API - summary: Creates a new Submodel Descriptor, i.e. registers a submodel - operationId: PostSubmodelDescriptor-ThroughSuperpath # TODO - x-semanticIds: - - https://admin-shell.io/aas/API/PostSubmodelDescriptor/3/0 - requestBody: - description: Submodel Descriptor object - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/SubmodelDescriptor' - required: true - responses: - '201': - description: Submodel Descriptor created successfully - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/SubmodelDescriptor' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '409': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/conflict' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /shell-descriptors/{aasIdentifier}/submodel-descriptors/{submodelIdentifier}: - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/AssetAdministrationShellIdentifier' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/SubmodelIdentifier' - get: - tags: - - Asset Administration Shell Registry API - summary: Returns a specific Submodel Descriptor - operationId: GetSubmodelDescriptorByIdThroughSuperpath - x-semanticIds: - - https://admin-shell.io/aas/API/GetSubmodelDescriptorById/3/0 - responses: - '200': - description: Requested Submodel Descriptor - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/SubmodelDescriptor' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - put: - tags: - - Asset Administration Shell Registry API - summary: Updates an existing Submodel Descriptor - operationId: PutSubmodelDescriptorByIdThroughSuperpath - x-semanticIds: - - https://admin-shell.io/aas/API/PutSubmodelDescriptorById/3/0 - requestBody: - description: Submodel Descriptor object - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/SubmodelDescriptor' - required: true - responses: - '204': - description: Submodel Descriptor updated successfully - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - delete: - tags: - - Asset Administration Shell Registry API - summary: Deletes a Submodel Descriptor, i.e. de-registers a submodel - operationId: DeleteSubmodelDescriptorByIdThroughSuperpath - x-semanticIds: - - https://admin-shell.io/aas/API/DeleteSubmodelDescriptorById/3/0 - responses: - '204': - description: Submodel Descriptor deleted successfully - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - - - /submodel-descriptors: - get: - tags: - - Submodel Registry API - summary: Returns all Submodel Descriptors - operationId: GetAllSubmodelDescriptors - x-semanticIds: - - https://admin-shell.io/aas/API/GetAllSubmodelDescriptors/3/0 - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Limit' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Cursor' - responses: - '200': - description: Requested Submodel Descriptors - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/GetSubmodelDescriptorsResult' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - post: - tags: - - Submodel Registry API - summary: Creates a new Submodel Descriptor, i.e. registers a submodel - operationId: PostSubmodelDescriptor - x-semanticIds: - - https://admin-shell.io/aas/API/PostSubmodelDescriptor/3/0 - requestBody: - description: Submodel Descriptor object - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/SubmodelDescriptor' - required: true - responses: - '201': - description: Submodel Descriptor created successfully - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/SubmodelDescriptor' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '409': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/conflict' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /submodel-descriptors/{submodelIdentifier}: - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/SubmodelIdentifier' - get: - tags: - - Submodel Registry API - summary: Returns a specific Submodel Descriptor - operationId: GetSubmodelDescriptorById - x-semanticIds: - - https://admin-shell.io/aas/API/GetSubmodelDescriptorById/3/0 - responses: - '200': - description: Requested Submodel Descriptor - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/SubmodelDescriptor' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - put: - tags: - - Submodel Registry API - summary: Updates an existing Submodel Descriptor - operationId: PutSubmodelDescriptorById - x-semanticIds: - - https://admin-shell.io/aas/API/PutSubmodelDescriptorById/3/0 - requestBody: - description: Submodel Descriptor object - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/SubmodelDescriptor' - required: true - responses: - '204': - description: Submodel Descriptor updated successfully - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - delete: - tags: - - Submodel Registry API - summary: Deletes a Submodel Descriptor, i.e. de-registers a submodel - operationId: DeleteSubmodelDescriptorById - x-semanticIds: - - https://admin-shell.io/aas/API/DeleteSubmodelDescriptorById/3/0 - responses: - '204': - description: Submodel Descriptor deleted successfully - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - - - /lookup/shells: - get: - tags: - - Asset Administration Shell Basic Discovery API - summary: Returns a list of Asset Administration Shell ids linked to specific Asset identifiers - operationId: GetAllAssetAdministrationShellIdsByAssetLink - x-semanticIds: - - https://admin-shell.io/aas/API/GetAllAssetAdministrationShellIdsByAssetLink/3/0 - parameters: - - name: assetIds - in: query - description: A list of specific Asset identifiers - required: false - style: form - explode: true - schema: - type: array - items: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0#/components/schemas/SpecificAssetId' - example: '[ { "name": "some-asset-id", "value": "http://example-company.com/myAsset", "externalSubjectId": { "keys": [ { "type": "GlobalReference", "value": "http://example-company.com/example-companys-asset-keys" } ], "type": "GlobalReference" } }, { "name": "some-other-asset-id", "value": "12345ABC", "externalSubjectId": { "keys": [ { "type": "GlobalReference", "value": "http://my-own-company.com/keys" } ], "type": "GlobalReference" } } ]' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Limit' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Cursor' - responses: - '200': - description: Requested Asset Administration Shell ids - content: - application/json: - schema: - type: array - items: - type: string - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /lookup/shells/{aasIdentifier}: - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/AssetAdministrationShellIdentifier' - get: - tags: - - Asset Administration Shell Basic Discovery API - summary: Returns a list of specific Asset identifiers based on an Asset Administration Shell id to edit discoverable content - operationId: GetAllAssetLinksById - x-semanticIds: - - https://admin-shell.io/aas/API/GetAllAssetLinksById/3/0 - responses: - '200': - description: Requested specific Asset identifiers - content: - application/json: - schema: - type: array - items: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0#/components/schemas/SpecificAssetId' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - post: - tags: - - Asset Administration Shell Basic Discovery API - summary: Creates specific Asset identifiers linked to an Asset Administration Shell to edit discoverable content - operationId: PostAllAssetLinksById - x-semanticIds: - - https://admin-shell.io/aas/API/PostAllAssetLinksById/3/0 - requestBody: - description: A list of specific Asset identifiers - content: - application/json: - schema: - type: array - items: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0#/components/schemas/SpecificAssetId' - required: true - responses: - '201': - description: Specific Asset identifiers created successfully - content: - application/json: - schema: - type: array - items: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0#/components/schemas/SpecificAssetId' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '409': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/conflict' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - delete: - tags: - - Asset Administration Shell Basic Discovery API - summary: Deletes all specific Asset identifiers linked to an Asset Administration Shell to edit discoverable content - operationId: DeleteAllAssetLinksById - x-semanticIds: - - https://admin-shell.io/aas/API/DeleteAllAssetLinksById/3/0 - responses: - '204': - description: Specific Asset identifiers deleted successfully - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - - - /packages: - get: - tags: - - AASX File Server API - summary: Returns a list of available AASX packages at the server - operationId: GetAllAASXPackageIds - x-semanticIds: - - https://admin-shell.io/aas/API/GetAllAASXPackageIds/3/0 - parameters: - - name: aasId - in: query - description: The Asset Administration Shell’s unique id (UTF8-BASE64-URL-encoded) - required: false - style: form - explode: true - schema: - type: string - format: byte - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Limit' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Cursor' - responses: - '200': - description: Requested package list - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/GetPackageDescriptionsResult' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - post: - tags: - - AASX File Server API - summary: Stores the AASX package at the server - operationId: PostAASXPackage - x-semanticIds: - - https://admin-shell.io/aas/API/PostAASXPackage/3/0 - requestBody: - description: AASX package - content: - multipart/form-data: - schema: - type: object - properties: - aasIds: - type: array - items: - type: string - file: - type: string - format: binary - fileName: - type: string - encoding: - file: - contentType: application/asset-administration-shell-package - required: true - responses: - '201': - description: AASX package stored successfully - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/PackageDescription' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '409': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/conflict' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /packages/{packageId}: - parameters: - - name: packageId - in: path - description: The package Id (UTF8-BASE64-URL-encoded) - required: true - style: simple - explode: true - schema: - type: string - format: byte - get: - tags: - - AASX File Server API - summary: Returns a specific AASX package from the server - operationId: GetAASXByPackageId - x-semanticIds: - - https://admin-shell.io/aas/API/GetAASXByPackageId/3/0 - responses: - '200': - description: Requested AASX package - headers: - X-FileName: - schema: - type: string - description: Filename of the package - content: - application/asset-administration-shell-package: - schema: - type: string - format: binary - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - put: - tags: - - AASX File Server API - summary: Updates the AASX package at the server - operationId: PutAASXByPackageId - x-semanticIds: - - https://admin-shell.io/aas/API/PutAASXByPackageId/3/0 - requestBody: - description: AASX package - content: - multipart/form-data: - schema: - type: object - properties: - aasIds: - type: array - items: - type: string - file: - type: string - format: binary - fileName: - type: string - encoding: - file: - contentType: application/asset-administration-shell-package - required: true - responses: - '204': - description: AASX package updated successfully - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - delete: - tags: - - AASX File Server API - summary: Deletes a specific AASX package from the server - operationId: DeleteAASXByPackageId - x-semanticIds: - - https://admin-shell.io/aas/API/DeleteAASXByPackageId/3/0 - responses: - '204': - description: Deleted successfully - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - - - /serialization: - get: - tags: - - Serialization API - summary: Returns an appropriate serialization based on the specified format (see SerializationFormat) - operationId: GenerateSerializationByIds - x-semanticIds: - - https://admin-shell.io/aas/API/GenerateSerializationByIds/3/0 - parameters: - - name: aasIds - in: query - description: The Asset Administration Shells' unique ids (UTF8-BASE64-URL-encoded) - style: form - explode: true - schema: - type: array - items: - type: string - - name: submodelIds - in: query - description: The Submodels' unique ids (UTF8-BASE64-URL-encoded) - style: form - explode: true - schema: - type: array - items: - type: string - - name: includeConceptDescriptions - in: query - description: Include Concept Descriptions? - style: form - explode: true - schema: - type: boolean - default: true - responses: - '200': - description: Requested serialization based on SerializationFormat - content: - application/asset-administration-shell-package+xml: - schema: - description: AASX package - type: string - format: binary - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0#/components/schemas/Environment' - application/xml: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0#/components/schemas/Environment' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '401': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/unauthorized' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - - /description: - get: - tags: - - Description API - summary: Returns the self-describing information of a network resource (ServiceDescription) - operationId: GetDescription - x-semanticIds: - - https://admin-shell.io/aas/API/Descriptor/GetDescription/3/0 - responses: - '200': - description: Requested Description - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/ServiceDescription' - '401': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/unauthorized' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' \ No newline at end of file diff --git a/Registry-and-Discovery/openapi.yaml b/Registry-and-Discovery/openapi.yaml deleted file mode 100644 index a651b4cd..00000000 --- a/Registry-and-Discovery/openapi.yaml +++ /dev/null @@ -1,583 +0,0 @@ -openapi: 3.0.3 -info: - title: DotAAS Part 2 | HTTP/REST | Registry and Discovery API - description: The registry and discovery API as part of Details of the Asset Administration Shell Part 2 - contact: - name: Constantin Ziesche, Andreas Orzelski, Florian Krebs, Bastian Rössl, Manuel Sauer, Jens Vialkowitsch, Michael Hoffmeister, Torben Miny, Sebastian Bader, Marko Ristin, Nico Braunisch - version: V1.0RC03 - termsOfService: https://github.com/admin-shell-io/aas-specs -servers: -- url: '{protocol}://{host_name}:{port}/api/{version_prefix}' - variables: - protocol: - description: 'Allows access through http and https (recommended)' - enum: - - 'http' - - 'https' - default: 'https' - host_name: - default: admin-shell.io - description: 'Hostname of server hosting the api' - port: - enum: - - '80' - - '443' - default: '443' - description: '80 is default for http, 443 for https' - version_prefix: - enum: - - 'v1' - default: v1 -paths: - /shell-descriptors: - get: - tags: - - Registry and Discovery API - summary: Returns all Asset Administration Shell Descriptors - operationId: GetAllAssetAdministrationShellDescriptors - x-semanticIds: - - https://admin-shell.io/aas/API/GetAllAssetAdministrationShellDescriptors/1/0/RC03 - responses: - '200': - description: Requested Asset Administration Shell Descriptors - content: - application/json: - schema: - type: array - items: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V1.0RC03#/components/schemas/AssetAdministrationShellDescriptor' - default: - description: Default error handling for unmentioned status codes - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V1.0RC03#/components/schemas/Result' - post: - tags: - - Registry and Discovery API - summary: Creates a new Asset Administration Shell Descriptor, i.e. registers an AAS - operationId: PostAssetAdministrationShellDescriptor - x-semanticIds: - - https://admin-shell.io/aas/API/PostAssetAdministrationShellDescriptor/1/0/RC03 - requestBody: - description: Asset Administration Shell Descriptor object - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V1.0RC03#/components/schemas/AssetAdministrationShellDescriptor' - required: true - responses: - '201': - description: Asset Administration Shell Descriptor created successfully - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V1.0RC03#/components/schemas/AssetAdministrationShellDescriptor' - '400': - description: Bad Request - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V1.0RC03#/components/schemas/Result' - default: - description: Default error handling for unmentioned status codes - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V1.0RC03#/components/schemas/Result' - /shell-descriptors/{aasIdentifier}: - get: - tags: - - Registry and Discovery API - summary: Returns a specific Asset Administration Shell Descriptor - operationId: GetAssetAdministrationShellDescriptorById - x-semanticIds: - - https://admin-shell.io/aas/API/GetAssetAdministrationShellDescriptorById/1/0/RC03 - parameters: - - name: aasIdentifier - in: path - description: The Asset Administration Shell’s unique id (UTF8-BASE64-URL-encoded) - required: true - style: simple - explode: false - schema: - type: string - format: byte - responses: - '200': - description: Requested Asset Administration Shell Descriptor - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V1.0RC03#/components/schemas/AssetAdministrationShellDescriptor' - '404': - description: Not Found - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V1.0RC03#/components/schemas/Result' - default: - description: Default error handling for unmentioned status codes - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V1.0RC03#/components/schemas/Result' - put: - tags: - - Registry and Discovery API - summary: Updates an existing Asset Administration Shell Descriptor - operationId: PutAssetAdministrationShellDescriptorById - x-semanticIds: - - https://admin-shell.io/aas/API/PutAssetAdministrationShellDescriptorById/1/0/RC03 - parameters: - - name: aasIdentifier - in: path - description: The Asset Administration Shell’s unique id (UTF8-BASE64-URL-encoded) - required: true - style: simple - explode: false - schema: - type: string - format: byte - requestBody: - description: Asset Administration Shell Descriptor object - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V1.0RC03#/components/schemas/AssetAdministrationShellDescriptor' - required: true - responses: - '204': - description: Asset Administration Shell Descriptor updated successfully - '400': - description: Bad Request - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V1.0RC03#/components/schemas/Result' - '404': - description: Not Found - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V1.0RC03#/components/schemas/Result' - default: - description: Default error handling for unmentioned status codes - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V1.0RC03#/components/schemas/Result' - delete: - tags: - - Registry and Discovery API - summary: Deletes an Asset Administration Shell Descriptor, i.e. de-registers an AAS - operationId: DeleteAssetAdministrationShellDescriptorById - x-semanticIds: - - https://admin-shell.io/aas/API/DeleteAssetAdministrationShellDescriptorById/1/0/RC03 - parameters: - - name: aasIdentifier - in: path - description: The Asset Administration Shell’s unique id (UTF8-BASE64-URL-encoded) - required: true - style: simple - explode: false - schema: - type: string - format: byte - responses: - '204': - description: Asset Administration Shell Descriptor deleted successfully - '404': - description: Not Found - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V1.0RC03#/components/schemas/Result' - default: - description: Default error handling for unmentioned status codes - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V1.0RC03#/components/schemas/Result' - /shell-descriptors/{aasIdentifier}/submodel-descriptors: - get: - tags: - - Registry and Discovery API - summary: Returns all Submodel Descriptors - operationId: GetAllSubmodelDescriptors_AASRegistry - x-semanticIds: - - https://admin-shell.io/aas/API/GetAllSubmodelDescriptors/1/0/RC03 - parameters: - - name: aasIdentifier - in: path - description: The Asset Administration Shell’s unique id (UTF8-BASE64-URL-encoded) - required: true - style: simple - explode: false - schema: - type: string - format: byte - responses: - '200': - description: Requested Submodel Descriptors - content: - application/json: - schema: - type: array - items: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V1.0RC03#/components/schemas/SubmodelDescriptor' - '404': - description: Not Found - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V1.0RC03#/components/schemas/Result' - default: - description: Default error handling for unmentioned status codes - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V1.0RC03#/components/schemas/Result' - post: - tags: - - Registry and Discovery API - summary: Creates a new Submodel Descriptor, i.e. registers a submodel - operationId: PostSubmodelDescriptor_AASRegistry - x-semanticIds: - - https://admin-shell.io/aas/API/PostSubmodelDescriptor/1/0/RC03 - parameters: - - name: aasIdentifier - in: path - description: The Asset Administration Shell’s unique id (UTF8-BASE64-URL-encoded) - required: true - style: simple - explode: false - schema: - type: string - format: byte - requestBody: - description: Submodel Descriptor object - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V1.0RC03#/components/schemas/SubmodelDescriptor' - required: true - responses: - '201': - description: Submodel Descriptor created successfully - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V1.0RC03#/components/schemas/SubmodelDescriptor' - '400': - description: Bad Request - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V1.0RC03#/components/schemas/Result' - '404': - description: Not Found - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V1.0RC03#/components/schemas/Result' - default: - description: Default error handling for unmentioned status codes - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V1.0RC03#/components/schemas/Result' - /shell-descriptors/{aasIdentifier}/submodel-descriptors/{submodelIdentifier}: - get: - tags: - - Registry and Discovery API - summary: Returns a specific Submodel Descriptor - operationId: GetSubmodelDescriptorById_AASRegistry - x-semanticIds: - - https://admin-shell.io/aas/API/GetSubmodelDescriptorById/1/0/RC03 - parameters: - - name: aasIdentifier - in: path - description: The Asset Administration Shell’s unique id (UTF8-BASE64-URL-encoded) - required: true - style: simple - explode: false - schema: - type: string - - name: submodelIdentifier - in: path - description: The Submodel’s unique id (UTF8-BASE64-URL-encoded) - required: true - style: simple - explode: false - schema: - type: string - responses: - '200': - description: Requested Submodel Descriptor - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V1.0RC03#/components/schemas/SubmodelDescriptor' - '404': - description: Not Found - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V1.0RC03#/components/schemas/Result' - default: - description: Default error handling for unmentioned status codes - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V1.0RC03#/components/schemas/Result' - put: - tags: - - Registry and Discovery API - summary: Updates an existing Submodel Descriptor - operationId: PutSubmodelDescriptorById_AASRegistry - x-semanticIds: - - https://admin-shell.io/aas/API/PutSubmodelDescriptorById/1/0/RC03 - parameters: - - name: aasIdentifier - in: path - description: The Asset Administration Shell’s unique id (UTF8-BASE64-URL-encoded) - required: true - style: simple - explode: false - schema: - type: string - - name: submodelIdentifier - in: path - description: The Submodel’s unique id (UTF8-BASE64-URL-encoded) - required: true - style: simple - explode: false - schema: - type: string - requestBody: - description: Submodel Descriptor object - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V1.0RC03#/components/schemas/SubmodelDescriptor' - required: true - responses: - '204': - description: Submodel Descriptor updated successfully - '400': - description: Bad Request - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V1.0RC03#/components/schemas/Result' - '404': - description: Not Found - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V1.0RC03#/components/schemas/Result' - default: - description: Default error handling for unmentioned status codes - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V1.0RC03#/components/schemas/Result' - delete: - tags: - - Registry and Discovery API - summary: Deletes a Submodel Descriptor, i.e. de-registers a submodel - operationId: DeleteSubmodelDescriptorById_AASRegistry - x-semanticIds: - - https://admin-shell.io/aas/API/DeleteSubmodelDescriptorById/1/0/RC03 - parameters: - - name: aasIdentifier - in: path - description: The Asset Administration Shell’s unique id (UTF8-BASE64-URL-encoded) - required: true - style: simple - explode: false - schema: - type: string - - name: submodelIdentifier - in: path - description: The Submodel’s unique id (UTF8-BASE64-URL-encoded) - required: true - style: simple - explode: false - schema: - type: string - responses: - '204': - description: Submodel Descriptor deleted successfully - '404': - description: Not Found - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V1.0RC03#/components/schemas/Result' - default: - description: Default error handling for unmentioned status codes - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V1.0RC03#/components/schemas/Result' - /lookup/shells: - get: - tags: - - Registry and Discovery API - summary: Returns a list of Asset Administration Shell ids linked to specific Asset identifiers - operationId: GetAllAssetAdministrationShellIdsByAssetLink - x-semanticIds: - - https://admin-shell.io/aas/API/GetAllAssetAdministrationShellIdsByAssetLink/1/0/RC03 - parameters: - - name: assetIds - in: query - description: A list of specific Asset identifiers - required: false - style: form - explode: true - schema: - type: array - items: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0RC02#/components/schemas/SpecificAssetId' - example: '[ { "name": "some-asset-id", "value": "http://example-company.com/myAsset", "externalSubjectId": { "keys": [ { "type": "GlobalReference", "value": "http://example-company.com/example-companys-asset-keys" } ], "type": "GlobalReference" } }, { "name": "some-other-asset-id", "value": "12345ABC", "externalSubjectId": { "keys": [ { "type": "GlobalReference", "value": "http://my-own-company.com/keys" } ], "type": "GlobalReference" } } ]e": "globalAssetId","value": "http://example.company/myAsset", "externalSubjectId": "http://example.company"},{"name": "myOwnInternalAssetId","value": "12345ABC", "externalSubjectId": "http://example.company"}]' - responses: - '200': - description: Requested Asset Administration Shell ids - content: - application/json: - schema: - type: array - items: - type: string - default: - description: Default error handling for unmentioned status codes - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V1.0RC03#/components/schemas/Result' - /lookup/shells/{aasIdentifier}: - get: - tags: - - Registry and Discovery API - summary: Returns a list of specific Asset identifiers based on an Asset Administration Shell id to edit discoverable content - operationId: GetAllAssetLinksById - x-semanticIds: - - https://admin-shell.io/aas/API/GetAllAssetLinksById/1/0/RC03 - parameters: - - name: aasIdentifier - in: path - description: The Asset Administration Shell’s unique id (UTF8-BASE64-URL-encoded) - required: true - style: simple - explode: false - schema: - type: string - format: byte - responses: - '200': - description: Requested specific Asset identifiers - content: - application/json: - schema: - type: array - items: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0RC02#/components/schemas/SpecificAssetId' - '404': - description: Not Found - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V1.0RC03#/components/schemas/Result' - default: - description: Default error handling for unmentioned status codes - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V1.0RC03#/components/schemas/Result' - post: - tags: - - Registry and Discovery API - summary: Creates specific Asset identifiers linked to an Asset Administration Shell to edit discoverable content - operationId: PostAllAssetLinksById - x-semanticIds: - - https://admin-shell.io/aas/API/PostAllAssetLinksById/1/0/RC03 - parameters: - - name: aasIdentifier - in: path - description: The Asset Administration Shell’s unique id (UTF8-BASE64-URL-encoded) - required: true - style: simple - explode: false - schema: - type: string - format: bytev - requestBody: - description: A list of specific Asset identifiers - content: - application/json: - schema: - type: array - items: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0RC02#/components/schemas/SpecificAssetId' - required: true - responses: - '201': - description: Specific Asset identifiers created successfully - content: - application/json: - schema: - type: array - items: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0RC02#/components/schemas/SpecificAssetId' - '400': - description: Bad Request - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V1.0RC03#/components/schemas/Result' - '404': - description: Not Found - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V1.0RC03#/components/schemas/Result' - default: - description: Default error handling for unmentioned status codes - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V1.0RC03#/components/schemas/Result' - delete: - tags: - - Registry and Discovery API - summary: Deletes all specific Asset identifiers linked to an Asset Administration Shell to edit discoverable content - operationId: DeleteAllAssetLinksById - x-semanticIds: - - https://admin-shell.io/aas/API/DeleteAllAssetLinksById/1/0/RC03 - parameters: - - name: aasIdentifier - in: path - description: The Asset Administration Shell’s unique id (UTF8-BASE64-URL-encoded) - required: true - style: simple - explode: false - schema: - type: string - format: byte - responses: - '204': - description: Specific Asset identifiers deleted successfully - '404': - description: Not Found - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V1.0RC03#/components/schemas/Result' - default: - description: Default error handling for unmentioned status codes - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V1.0RC03#/components/schemas/Result' \ No newline at end of file diff --git a/RegistryAndDiscoveryServiceSpecification/V3.0.yaml b/RegistryAndDiscoveryServiceSpecification/V3.0.yaml deleted file mode 100644 index d56fbc5e..00000000 --- a/RegistryAndDiscoveryServiceSpecification/V3.0.yaml +++ /dev/null @@ -1,581 +0,0 @@ -openapi: 3.0.3 -info: - title: DotAAS Part 2 | HTTP/REST | Registry and Discovery Service Specification - description: "The entire Registry & Discovery Service Specification as part of Details of the Asset Administration Shell Part 2 - Copyright: Industrial Digital Twin Association (IDTA) 2023" - contact: - name: Industrial Digital Twin Association (IDTA) - email: info@idtwin.org - license: - name: CC BY-SA 4.0 - url: https://creativecommons.org/licenses/by-sa/4.0/ - version: V3.0 - termsOfService: https://github.com/admin-shell-io/aas-specs -servers: -- url: '{protocol}://{host_name}:{port}/api/{version_prefix}' - variables: - protocol: - description: 'Allows access through http and https (recommended)' - enum: - - 'http' - - 'https' - default: 'https' - host_name: - default: admin-shell.io - description: 'Hostname of server hosting the api' - port: - enum: - - '80' - - '443' - default: '443' - description: '80 is default for http, 443 for https' - version_prefix: - enum: - - 'v3.0' - default: v3.0 -paths: - /shell-descriptors: - get: - tags: - - Asset Administration Shell Registry API - summary: Returns all Asset Administration Shell Descriptors - operationId: GetAllAssetAdministrationShellDescriptors - x-semanticIds: - - https://admin-shell.io/aas/API/GetAllAssetAdministrationShellDescriptors/3/0 - - https://admin-shell.io/aas/API/GetAllAssetAdministrationShellDescriptorsByAssetKind/3/0 - - https://admin-shell.io/aas/API/GetAllAssetAdministrationShellDescriptorsByAssetType/3/0 - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Limit' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Cursor' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/AssetKind' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/AssetType' - responses: - '200': - description: Requested Asset Administration Shell Descriptors - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/GetAssetAdministrationShellDescriptorsResult' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - post: - tags: - - Asset Administration Shell Registry API - summary: Creates a new Asset Administration Shell Descriptor, i.e. registers an AAS - operationId: PostAssetAdministrationShellDescriptor - x-semanticIds: - - https://admin-shell.io/aas/API/PostAssetAdministrationShellDescriptor/3/0 - requestBody: - description: Asset Administration Shell Descriptor object - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/AssetAdministrationShellDescriptor' - required: true - responses: - '201': - description: Asset Administration Shell Descriptor created successfully - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/AssetAdministrationShellDescriptor' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '409': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/conflict' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /shell-descriptors/{aasIdentifier}: - get: - tags: - - Asset Administration Shell Registry API - summary: Returns a specific Asset Administration Shell Descriptor - operationId: GetAssetAdministrationShellDescriptorById - x-semanticIds: - - https://admin-shell.io/aas/API/GetAssetAdministrationShellDescriptorById/3/0 - parameters: - - name: aasIdentifier - in: path - description: The Asset Administration Shell’s unique id (UTF8-BASE64-URL-encoded) - required: true - style: simple - explode: false - schema: - type: string - format: byte - responses: - '200': - description: Requested Asset Administration Shell Descriptor - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/AssetAdministrationShellDescriptor' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - put: - tags: - - Asset Administration Shell Registry API - summary: Updates an existing Asset Administration Shell Descriptor - operationId: PutAssetAdministrationShellDescriptorById - x-semanticIds: - - https://admin-shell.io/aas/API/PutAssetAdministrationShellDescriptorById/3/0 - parameters: - - name: aasIdentifier - in: path - description: The Asset Administration Shell’s unique id (UTF8-BASE64-URL-encoded) - required: true - style: simple - explode: false - schema: - type: string - format: byte - requestBody: - description: Asset Administration Shell Descriptor object - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/AssetAdministrationShellDescriptor' - required: true - responses: - '204': - description: Asset Administration Shell Descriptor updated successfully - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - delete: - tags: - - Asset Administration Shell Registry API - summary: Deletes an Asset Administration Shell Descriptor, i.e. de-registers an AAS - operationId: DeleteAssetAdministrationShellDescriptorById - x-semanticIds: - - https://admin-shell.io/aas/API/DeleteAssetAdministrationShellDescriptorById/3/0 - parameters: - - name: aasIdentifier - in: path - description: The Asset Administration Shell’s unique id (UTF8-BASE64-URL-encoded) - required: true - style: simple - explode: false - schema: - type: string - format: byte - responses: - '204': - description: Asset Administration Shell Descriptor deleted successfully - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /shell-descriptors/{aasIdentifier}/submodel-descriptors: - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/AssetAdministrationShellIdentifier' - get: - tags: - - Asset Administration Shell Registry API - summary: Returns all Submodel Descriptors - operationId: GetAllSubmodelDescriptorsThroughSuperpath - x-semanticIds: - - https://admin-shell.io/aas/API/GetAllSubmodelDescriptors/3/0 - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Limit' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Cursor' - responses: - '200': - description: Requested Submodel Descriptors - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/GetSubmodelDescriptorsResult' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - post: - tags: - - Asset Administration Shell Registry API - summary: Creates a new Submodel Descriptor, i.e. registers a submodel - operationId: PostSubmodelDescriptor-ThroughSuperpath # TODO - x-semanticIds: - - https://admin-shell.io/aas/API/PostSubmodelDescriptor/3/0 - requestBody: - description: Submodel Descriptor object - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/SubmodelDescriptor' - required: true - responses: - '201': - description: Submodel Descriptor created successfully - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/SubmodelDescriptor' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '409': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/conflict' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /shell-descriptors/{aasIdentifier}/submodel-descriptors/{submodelIdentifier}: - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/AssetAdministrationShellIdentifier' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/SubmodelIdentifier' - get: - tags: - - Asset Administration Shell Registry API - summary: Returns a specific Submodel Descriptor - operationId: GetSubmodelDescriptorByIdThroughSuperpath - x-semanticIds: - - https://admin-shell.io/aas/API/GetSubmodelDescriptorById/3/0 - responses: - '200': - description: Requested Submodel Descriptor - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/SubmodelDescriptor' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - put: - tags: - - Asset Administration Shell Registry API - summary: Updates an existing Submodel Descriptor - operationId: PutSubmodelDescriptorByIdThroughSuperpath - x-semanticIds: - - https://admin-shell.io/aas/API/PutSubmodelDescriptorById/3/0 - requestBody: - description: Submodel Descriptor object - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/SubmodelDescriptor' - required: true - responses: - '204': - description: Submodel Descriptor updated successfully - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - delete: - tags: - - Asset Administration Shell Registry API - summary: Deletes a Submodel Descriptor, i.e. de-registers a submodel - operationId: DeleteSubmodelDescriptorByIdThroughSuperpath - x-semanticIds: - - https://admin-shell.io/aas/API/DeleteSubmodelDescriptorById/3/0 - responses: - '204': - description: Submodel Descriptor deleted successfully - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /submodel-descriptors: - get: - tags: - - Submodel Registry API - summary: Returns all Submodel Descriptors - operationId: GetAllSubmodelDescriptors - x-semanticIds: - - https://admin-shell.io/aas/API/GetAllSubmodelDescriptors/3/0 - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Limit' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Cursor' - responses: - '200': - description: Requested Submodel Descriptors - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/GetSubmodelDescriptorsResult' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - post: - tags: - - Submodel Registry API - summary: Creates a new Submodel Descriptor, i.e. registers a submodel - operationId: PostSubmodelDescriptor - x-semanticIds: - - https://admin-shell.io/aas/API/PostSubmodelDescriptor/3/0 - requestBody: - description: Submodel Descriptor object - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/SubmodelDescriptor' - required: true - responses: - '201': - description: Submodel Descriptor created successfully - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/SubmodelDescriptor' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '409': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/conflict' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /submodel-descriptors/{submodelIdentifier}: - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/SubmodelIdentifier' - get: - tags: - - Submodel Registry API - summary: Returns a specific Submodel Descriptor - operationId: GetSubmodelDescriptorById - x-semanticIds: - - https://admin-shell.io/aas/API/GetSubmodelDescriptorById/3/0 - responses: - '200': - description: Requested Submodel Descriptor - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/SubmodelDescriptor' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - put: - tags: - - Submodel Registry API - summary: Updates an existing Submodel Descriptor - operationId: PutSubmodelDescriptorById - x-semanticIds: - - https://admin-shell.io/aas/API/PutSubmodelDescriptorById/3/0 - requestBody: - description: Submodel Descriptor object - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/SubmodelDescriptor' - required: true - responses: - '204': - description: Submodel Descriptor updated successfully - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - delete: - tags: - - Submodel Registry API - summary: Deletes a Submodel Descriptor, i.e. de-registers a submodel - operationId: DeleteSubmodelDescriptorById - x-semanticIds: - - https://admin-shell.io/aas/API/DeleteSubmodelDescriptorById/3/0 - responses: - '204': - description: Submodel Descriptor deleted successfully - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - /lookup/shells: - get: - tags: - - Asset Administration Shell Basic Discovery API - summary: Returns a list of Asset Administration Shell ids linked to specific Asset identifiers - operationId: GetAllAssetAdministrationShellIdsByAssetLink - x-semanticIds: - - https://admin-shell.io/aas/API/GetAllAssetAdministrationShellIdsByAssetLink/3/0 - parameters: - - name: assetIds - in: query - description: A list of specific Asset identifiers - required: false - style: form - explode: true - schema: - type: array - items: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0#/components/schemas/SpecificAssetId' - example: '[ { "name": "some-asset-id", "value": "http://example-company.com/myAsset", "externalSubjectId": { "keys": [ { "type": "GlobalReference", "value": "http://example-company.com/example-companys-asset-keys" } ], "type": "GlobalReference" } }, { "name": "some-other-asset-id", "value": "12345ABC", "externalSubjectId": { "keys": [ { "type": "GlobalReference", "value": "http://my-own-company.com/keys" } ], "type": "GlobalReference" } } ]' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Limit' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Cursor' - responses: - '200': - description: Requested Asset Administration Shell ids - content: - application/json: - schema: - type: array - items: - type: string - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /lookup/shells/{aasIdentifier}: - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/AssetAdministrationShellIdentifier' - get: - tags: - - Asset Administration Shell Basic Discovery API - summary: Returns a list of specific Asset identifiers based on an Asset Administration Shell id to edit discoverable content - operationId: GetAllAssetLinksById - x-semanticIds: - - https://admin-shell.io/aas/API/GetAllAssetLinksById/3/0 - responses: - '200': - description: Requested specific Asset identifiers - content: - application/json: - schema: - type: array - items: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0#/components/schemas/SpecificAssetId' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - post: - tags: - - Asset Administration Shell Basic Discovery API - summary: Creates specific Asset identifiers linked to an Asset Administration Shell to edit discoverable content - operationId: PostAllAssetLinksById - x-semanticIds: - - https://admin-shell.io/aas/API/PostAllAssetLinksById/3/0 - requestBody: - description: A list of specific Asset identifiers - content: - application/json: - schema: - type: array - items: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0#/components/schemas/SpecificAssetId' - required: true - responses: - '201': - description: Specific Asset identifiers created successfully - content: - application/json: - schema: - type: array - items: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0#/components/schemas/SpecificAssetId' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '409': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/conflict' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - delete: - tags: - - Asset Administration Shell Basic Discovery API - summary: Deletes all specific Asset identifiers linked to an Asset Administration Shell to edit discoverable content - operationId: DeleteAllAssetLinksById - x-semanticIds: - - https://admin-shell.io/aas/API/DeleteAllAssetLinksById/3/0 - responses: - '204': - description: Specific Asset identifiers deleted successfully - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /description: - get: - tags: - - Description API - summary: Returns the self-describing information of a network resource (ServiceDescription) - operationId: GetDescription - x-semanticIds: - - https://admin-shell.io/aas/API/Descriptor/GetDescription/3/0 - responses: - '200': - description: Requested Description - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/ServiceDescription' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' \ No newline at end of file diff --git a/RegistryServiceSpecification/V3.0-AssetAdministrationShellRegistry.yaml b/RegistryServiceSpecification/V3.0-AssetAdministrationShellRegistry.yaml deleted file mode 100644 index b999a50b..00000000 --- a/RegistryServiceSpecification/V3.0-AssetAdministrationShellRegistry.yaml +++ /dev/null @@ -1,323 +0,0 @@ -openapi: 3.0.3 -info: - title: DotAAS Part 2 | HTTP/REST | Registry Service Specification - description: "The Asset Administration Shell Registry Profile of the Registry Service Specification as part of Details of the Asset Administration Shell Part 2 - Copyright: Industrial Digital Twin Association (IDTA) 2023" - contact: - name: Industrial Digital Twin Association (IDTA) - email: info@idtwin.org - license: - name: CC BY-SA 4.0 - url: https://creativecommons.org/licenses/by-sa/4.0/ - version: V3.0-AssetAdministrationShellRegistry - termsOfService: https://github.com/admin-shell-io/aas-specs -servers: -- url: '{protocol}://{host_name}:{port}/api/{version_prefix}' - variables: - protocol: - description: 'Allows access through http and https (recommended)' - enum: - - 'http' - - 'https' - default: 'https' - host_name: - default: admin-shell.io - description: 'Hostname of server hosting the api' - port: - enum: - - '80' - - '443' - default: '443' - description: '80 is default for http, 443 for https' - version_prefix: - enum: - - 'v3.0' - default: v3.0 -paths: - /shell-descriptors: - get: - tags: - - Asset Administration Shell Registry API - summary: Returns all Asset Administration Shell Descriptors - operationId: GetAllAssetAdministrationShellDescriptors - x-semanticIds: - - https://admin-shell.io/aas/API/GetAllAssetAdministrationShellDescriptors/3/0 - - https://admin-shell.io/aas/API/GetAllAssetAdministrationShellDescriptorsByAssetKind/3/0 - - https://admin-shell.io/aas/API/GetAllAssetAdministrationShellDescriptorsByAssetType/3/0 - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Limit' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Cursor' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/AssetKind' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/AssetType' - responses: - '200': - description: Requested Asset Administration Shell Descriptors - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/GetAssetAdministrationShellDescriptorsResult' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - post: - tags: - - Asset Administration Shell Registry API - summary: Creates a new Asset Administration Shell Descriptor, i.e. registers an AAS - operationId: PostAssetAdministrationShellDescriptor - x-semanticIds: - - https://admin-shell.io/aas/API/PostAssetAdministrationShellDescriptor/3/0 - requestBody: - description: Asset Administration Shell Descriptor object - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/AssetAdministrationShellDescriptor' - required: true - responses: - '201': - description: Asset Administration Shell Descriptor created successfully - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/AssetAdministrationShellDescriptor' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '409': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/conflict' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /shell-descriptors/{aasIdentifier}: - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/AssetAdministrationShellIdentifier' - get: - tags: - - Asset Administration Shell Registry API - summary: Returns a specific Asset Administration Shell Descriptor - operationId: GetAssetAdministrationShellDescriptorById - x-semanticIds: - - https://admin-shell.io/aas/API/GetAssetAdministrationShellDescriptorById/3/0 - responses: - '200': - description: Requested Asset Administration Shell Descriptor - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/AssetAdministrationShellDescriptor' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - put: - tags: - - Asset Administration Shell Registry API - summary: Updates an existing Asset Administration Shell Descriptor - operationId: PutAssetAdministrationShellDescriptorById - x-semanticIds: - - https://admin-shell.io/aas/API/PutAssetAdministrationShellDescriptorById/3/0 - requestBody: - description: Asset Administration Shell Descriptor object - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/AssetAdministrationShellDescriptor' - required: true - responses: - '204': - description: Asset Administration Shell Descriptor updated successfully - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - delete: - tags: - - Asset Administration Shell Registry API - summary: Deletes an Asset Administration Shell Descriptor, i.e. de-registers an AAS - operationId: DeleteAssetAdministrationShellDescriptorById - x-semanticIds: - - https://admin-shell.io/aas/API/DeleteAssetAdministrationShellDescriptorById/3/0 - responses: - '204': - description: Asset Administration Shell Descriptor deleted successfully - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /shell-descriptors/{aasIdentifier}/submodel-descriptors: - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/AssetAdministrationShellIdentifier' - get: - tags: - - Asset Administration Shell Registry API - summary: Returns all Submodel Descriptors - operationId: GetAllSubmodelDescriptorsThroughSuperpath - x-semanticIds: - - https://admin-shell.io/aas/API/GetAllSubmodelDescriptors/3/0 - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Limit' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Cursor' - responses: - '200': - description: Requested Submodel Descriptors - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/GetSubmodelDescriptorsResult' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - post: - tags: - - Asset Administration Shell Registry API - summary: Creates a new Submodel Descriptor, i.e. registers a submodel - operationId: PostSubmodelDescriptorThroughSuperpath - x-semanticIds: - - https://admin-shell.io/aas/API/PostSubmodelDescriptor/3/0 - requestBody: - description: Submodel Descriptor object - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/SubmodelDescriptor' - required: true - responses: - '201': - description: Submodel Descriptor created successfully - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/SubmodelDescriptor' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '409': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/conflict' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /shell-descriptors/{aasIdentifier}/submodel-descriptors/{submodelIdentifier}: - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/AssetAdministrationShellIdentifier' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/SubmodelIdentifier' - get: - tags: - - Asset Administration Shell Registry API - summary: Returns a specific Submodel Descriptor - operationId: GetSubmodelDescriptorByIdThroughSuperpath - x-semanticIds: - - https://admin-shell.io/aas/API/GetSubmodelDescriptorById/3/0 - responses: - '200': - description: Requested Submodel Descriptor - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/SubmodelDescriptor' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - put: - tags: - - Asset Administration Shell Registry API - summary: Updates an existing Submodel Descriptor - operationId: PutSubmodelDescriptorByIdThroughSuperpath - x-semanticIds: - - https://admin-shell.io/aas/API/PutSubmodelDescriptorById/3/0 - requestBody: - description: Submodel Descriptor object - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/SubmodelDescriptor' - required: true - responses: - '204': - description: Submodel Descriptor updated successfully - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - delete: - tags: - - Asset Administration Shell Registry API - summary: Deletes a Submodel Descriptor, i.e. de-registers a submodel - operationId: DeleteSubmodelDescriptorByIdThroughSuperpath - x-semanticIds: - - https://admin-shell.io/aas/API/DeleteSubmodelDescriptorById/3/0 - responses: - '204': - description: Submodel Descriptor deleted successfully - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /description: - get: - tags: - - Description API - summary: Returns the self-describing information of a network resource (ServiceDescription) - operationId: GetDescription - x-semanticIds: - - https://admin-shell.io/aas/API/Descriptor/GetDescription/3/0 - responses: - '200': - description: Requested Description - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/ServiceDescription' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' \ No newline at end of file diff --git a/RegistryServiceSpecification/V3.0-SubmodelRegistry.yaml b/RegistryServiceSpecification/V3.0-SubmodelRegistry.yaml deleted file mode 100644 index 63e35dc3..00000000 --- a/RegistryServiceSpecification/V3.0-SubmodelRegistry.yaml +++ /dev/null @@ -1,183 +0,0 @@ -openapi: 3.0.3 -info: - title: DotAAS Part 2 | HTTP/REST | Submodel Registry Service Specification - description: "The Submodel Registry profile of the Registry Service Specification as part of Details of the Asset Administration Shell Part 2 - Copyright: Industrial Digital Twin Association (IDTA) 2023" - contact: - name: Industrial Digital Twin Association (IDTA) - email: info@idtwin.org - license: - name: CC BY-SA 4.0 - url: https://creativecommons.org/licenses/by-sa/4.0/ - version: V3.0-SubmodelRegistry - termsOfService: https://github.com/admin-shell-io/aas-specs -servers: -- url: '{protocol}://{host_name}:{port}/api/{version_prefix}' - variables: - protocol: - description: 'Allows access through http and https (recommended)' - enum: - - 'http' - - 'https' - default: 'https' - host_name: - default: admin-shell.io - description: 'Hostname of server hosting the api' - port: - enum: - - '80' - - '443' - default: '443' - description: '80 is default for http, 443 for https' - version_prefix: - enum: - - 'v3.0' - default: v3.0 -paths: - /submodel-descriptors: - get: - tags: - - Submodel Registry API - summary: Returns all Submodel Descriptors - operationId: GetAllSubmodelDescriptors - x-semanticIds: - - https://admin-shell.io/aas/API/GetAllSubmodelDescriptors/3/0 - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Limit' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Cursor' - responses: - '200': - description: Requested Submodel Descriptors - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/GetSubmodelDescriptorsResult' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - post: - tags: - - Submodel Registry API - summary: Creates a new Submodel Descriptor, i.e. registers a submodel - operationId: PostSubmodelDescriptor - x-semanticIds: - - https://admin-shell.io/aas/API/PostSubmodelDescriptor/3/0 - requestBody: - description: Submodel Descriptor object - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/SubmodelDescriptor' - required: true - responses: - '201': - description: Submodel Descriptor created successfully - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/SubmodelDescriptor' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '409': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/conflict' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /submodel-descriptors/{submodelIdentifier}: - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/SubmodelIdentifier' - get: - tags: - - Submodel Registry API - summary: Returns a specific Submodel Descriptor - operationId: GetSubmodelDescriptorById - x-semanticIds: - - https://admin-shell.io/aas/API/GetSubmodelDescriptorById/3/0 - responses: - '200': - description: Requested Submodel Descriptor - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/SubmodelDescriptor' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - put: - tags: - - Submodel Registry API - summary: Updates an existing Submodel Descriptor - operationId: PutSubmodelDescriptorById - x-semanticIds: - - https://admin-shell.io/aas/API/PutSubmodelDescriptorById/3/0 - requestBody: - description: Submodel Descriptor object - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/SubmodelDescriptor' - required: true - responses: - '204': - description: Submodel Descriptor updated successfully - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - delete: - tags: - - Submodel Registry API - summary: Deletes a Submodel Descriptor, i.e. de-registers a submodel - operationId: DeleteSubmodelDescriptorById - x-semanticIds: - - https://admin-shell.io/aas/API/DeleteSubmodelDescriptorById/3/0 - responses: - '204': - description: Submodel Descriptor deleted successfully - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - /description: - get: - tags: - - Description API - summary: Returns the self-describing information of a network resource (ServiceDescription) - operationId: GetDescription - x-semanticIds: - - https://admin-shell.io/aas/API/Descriptor/GetDescription/3/0 - responses: - '200': - description: Requested Description - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/ServiceDescription' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' \ No newline at end of file diff --git a/RegistryServiceSpecification/V3.0.yaml b/RegistryServiceSpecification/V3.0.yaml deleted file mode 100644 index 613d0644..00000000 --- a/RegistryServiceSpecification/V3.0.yaml +++ /dev/null @@ -1,480 +0,0 @@ -openapi: 3.0.3 -info: - title: DotAAS Part 2 | HTTP/REST | Registry Service Specification - description: "The entire Registry Service Specification as part of Details of the Asset Administration Shell Part 2 - Copyright: Industrial Digital Twin Association (IDTA) 2023" - contact: - name: Industrial Digital Twin Association (IDTA) - email: info@idtwin.org - license: - name: CC BY-SA 4.0 - url: https://creativecommons.org/licenses/by-sa/4.0/ - version: V3.0 - termsOfService: https://github.com/admin-shell-io/aas-specs -servers: -- url: '{protocol}://{host_name}:{port}/api/{version_prefix}' - variables: - protocol: - description: 'Allows access through http and https (recommended)' - enum: - - 'http' - - 'https' - default: 'https' - host_name: - default: admin-shell.io - description: 'Hostname of server hosting the api' - port: - enum: - - '80' - - '443' - default: '443' - description: '80 is default for http, 443 for https' - version_prefix: - enum: - - 'v3.0' - default: v3.0 -paths: - /shell-descriptors: - get: - tags: - - Asset Administration Shell Registry API - summary: Returns all Asset Administration Shell Descriptors - operationId: GetAllAssetAdministrationShellDescriptors - x-semanticIds: - - https://admin-shell.io/aas/API/GetAllAssetAdministrationShellDescriptors/3/0 - - https://admin-shell.io/aas/API/GetAllAssetAdministrationShellDescriptorsByAssetKind/3/0 - - https://admin-shell.io/aas/API/GetAllAssetAdministrationShellDescriptorsByAssetType/3/0 - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Limit' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Cursor' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/AssetKind' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/AssetType' - responses: - '200': - description: Requested Asset Administration Shell Descriptors - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/GetAssetAdministrationShellDescriptorsResult' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - post: - tags: - - Asset Administration Shell Registry API - summary: Creates a new Asset Administration Shell Descriptor, i.e. registers an AAS - operationId: PostAssetAdministrationShellDescriptor - x-semanticIds: - - https://admin-shell.io/aas/API/PostAssetAdministrationShellDescriptor/3/0 - requestBody: - description: Asset Administration Shell Descriptor object - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/AssetAdministrationShellDescriptor' - required: true - responses: - '201': - description: Asset Administration Shell Descriptor created successfully - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/AssetAdministrationShellDescriptor' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '409': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/conflict' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /shell-descriptors/{aasIdentifier}: - get: - tags: - - Asset Administration Shell Registry API - summary: Returns a specific Asset Administration Shell Descriptor - operationId: GetAssetAdministrationShellDescriptorById - x-semanticIds: - - https://admin-shell.io/aas/API/GetAssetAdministrationShellDescriptorById/3/0 - parameters: - - name: aasIdentifier - in: path - description: The Asset Administration Shell’s unique id (UTF8-BASE64-URL-encoded) - required: true - style: simple - explode: false - schema: - type: string - format: byte - responses: - '200': - description: Requested Asset Administration Shell Descriptor - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/AssetAdministrationShellDescriptor' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - put: - tags: - - Asset Administration Shell Registry API - summary: Updates an existing Asset Administration Shell Descriptor - operationId: PutAssetAdministrationShellDescriptorById - x-semanticIds: - - https://admin-shell.io/aas/API/PutAssetAdministrationShellDescriptorById/3/0 - parameters: - - name: aasIdentifier - in: path - description: The Asset Administration Shell’s unique id (UTF8-BASE64-URL-encoded) - required: true - style: simple - explode: false - schema: - type: string - format: byte - requestBody: - description: Asset Administration Shell Descriptor object - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/AssetAdministrationShellDescriptor' - required: true - responses: - '204': - description: Asset Administration Shell Descriptor updated successfully - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - delete: - tags: - - Asset Administration Shell Registry API - summary: Deletes an Asset Administration Shell Descriptor, i.e. de-registers an AAS - operationId: DeleteAssetAdministrationShellDescriptorById - x-semanticIds: - - https://admin-shell.io/aas/API/DeleteAssetAdministrationShellDescriptorById/3/0 - parameters: - - name: aasIdentifier - in: path - description: The Asset Administration Shell’s unique id (UTF8-BASE64-URL-encoded) - required: true - style: simple - explode: false - schema: - type: string - format: byte - responses: - '204': - description: Asset Administration Shell Descriptor deleted successfully - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /shell-descriptors/{aasIdentifier}/submodel-descriptors: - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/AssetAdministrationShellIdentifier' - get: - tags: - - Asset Administration Shell Registry API - summary: Returns all Submodel Descriptors - operationId: GetAllSubmodelDescriptorsThroughSuperpath - x-semanticIds: - - https://admin-shell.io/aas/API/GetAllSubmodelDescriptors/3/0 - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Limit' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Cursor' - responses: - '200': - description: Requested Submodel Descriptors - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/GetSubmodelDescriptorsResult' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - post: - tags: - - Asset Administration Shell Registry API - summary: Creates a new Submodel Descriptor, i.e. registers a submodel - operationId: PostSubmodelDescriptor-ThroughSuperpath # TODO - x-semanticIds: - - https://admin-shell.io/aas/API/PostSubmodelDescriptor/3/0 - requestBody: - description: Submodel Descriptor object - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/SubmodelDescriptor' - required: true - responses: - '201': - description: Submodel Descriptor created successfully - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/SubmodelDescriptor' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '409': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/conflict' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /shell-descriptors/{aasIdentifier}/submodel-descriptors/{submodelIdentifier}: - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/AssetAdministrationShellIdentifier' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/SubmodelIdentifier' - get: - tags: - - Asset Administration Shell Registry API - summary: Returns a specific Submodel Descriptor - operationId: GetSubmodelDescriptorByIdThroughSuperpath - x-semanticIds: - - https://admin-shell.io/aas/API/GetSubmodelDescriptorById/3/0 - responses: - '200': - description: Requested Submodel Descriptor - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/SubmodelDescriptor' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - put: - tags: - - Asset Administration Shell Registry API - summary: Updates an existing Submodel Descriptor - operationId: PutSubmodelDescriptorByIdThroughSuperpath - x-semanticIds: - - https://admin-shell.io/aas/API/PutSubmodelDescriptorById/3/0 - requestBody: - description: Submodel Descriptor object - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/SubmodelDescriptor' - required: true - responses: - '204': - description: Submodel Descriptor updated successfully - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - delete: - tags: - - Asset Administration Shell Registry API - summary: Deletes a Submodel Descriptor, i.e. de-registers a submodel - operationId: DeleteSubmodelDescriptorByIdThroughSuperpath - x-semanticIds: - - https://admin-shell.io/aas/API/DeleteSubmodelDescriptorById/3/0 - responses: - '204': - description: Submodel Descriptor deleted successfully - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /submodel-descriptors: - get: - tags: - - Submodel Registry API - summary: Returns all Submodel Descriptors - operationId: GetAllSubmodelDescriptors - x-semanticIds: - - https://admin-shell.io/aas/API/GetAllSubmodelDescriptors/3/0 - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Limit' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Cursor' - responses: - '200': - description: Requested Submodel Descriptors - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/GetSubmodelDescriptorsResult' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - post: - tags: - - Submodel Registry API - summary: Creates a new Submodel Descriptor, i.e. registers a submodel - operationId: PostSubmodelDescriptor - x-semanticIds: - - https://admin-shell.io/aas/API/PostSubmodelDescriptor/3/0 - requestBody: - description: Submodel Descriptor object - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/SubmodelDescriptor' - required: true - responses: - '201': - description: Submodel Descriptor created successfully - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/SubmodelDescriptor' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '409': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/conflict' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /submodel-descriptors/{submodelIdentifier}: - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/SubmodelIdentifier' - get: - tags: - - Submodel Registry API - summary: Returns a specific Submodel Descriptor - operationId: GetSubmodelDescriptorById - x-semanticIds: - - https://admin-shell.io/aas/API/GetSubmodelDescriptorById/3/0 - responses: - '200': - description: Requested Submodel Descriptor - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/SubmodelDescriptor' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - put: - tags: - - Submodel Registry API - summary: Updates an existing Submodel Descriptor - operationId: PutSubmodelDescriptorById - x-semanticIds: - - https://admin-shell.io/aas/API/PutSubmodelDescriptorById/3/0 - requestBody: - description: Submodel Descriptor object - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/SubmodelDescriptor' - required: true - responses: - '204': - description: Submodel Descriptor updated successfully - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - delete: - tags: - - Submodel Registry API - summary: Deletes a Submodel Descriptor, i.e. de-registers a submodel - operationId: DeleteSubmodelDescriptorById - x-semanticIds: - - https://admin-shell.io/aas/API/DeleteSubmodelDescriptorById/3/0 - responses: - '204': - description: Submodel Descriptor deleted successfully - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - /description: - get: - tags: - - Description API - summary: Returns the self-describing information of a network resource (ServiceDescription) - operationId: GetDescription - x-semanticIds: - - https://admin-shell.io/aas/API/Descriptor/GetDescription/3/0 - responses: - '200': - description: Requested Description - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/ServiceDescription' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' \ No newline at end of file diff --git a/RegistryServiceSpecification/V3.0_SSP-001.yaml b/RegistryServiceSpecification/V3.0_SSP-001.yaml deleted file mode 100644 index 98c7a7e4..00000000 --- a/RegistryServiceSpecification/V3.0_SSP-001.yaml +++ /dev/null @@ -1,479 +0,0 @@ -openapi: 3.0.3 -info: - title: DotAAS Part 2 | HTTP/REST | Registry Service Specification - description: "The entire Registry Service Specification as part of Details of the Asset Administration Shell Part 2. Publisher: Industrial Digital Twin Association (IDTA) April 2023" - contact: - name: Industrial Digital Twin Association (IDTA) - email: info@idtwin.org - license: - name: CC BY 4.0 - url: https://creativecommons.org/licenses/by/4.0/ - version: V3.0_SSP-001 -servers: -- url: '{protocol}://{host_name}:{port}/api/{version_prefix}' - variables: - protocol: - description: 'Allows access through http and https (recommended)' - enum: - - 'http' - - 'https' - default: 'https' - host_name: - default: admin-shell.io - description: 'Hostname of server hosting the api' - port: - enum: - - '80' - - '443' - default: '443' - description: '80 is default for http, 443 for https' - version_prefix: - enum: - - 'v3.0' - default: v3.0 -paths: - /shell-descriptors: - get: - tags: - - Asset Administration Shell Registry API - summary: Returns all Asset Administration Shell Descriptors - operationId: GetAllAssetAdministrationShellDescriptors - x-semanticIds: - - https://admin-shell.io/aas/API/GetAllAssetAdministrationShellDescriptors/3/0 - - https://admin-shell.io/aas/API/GetAllAssetAdministrationShellDescriptorsByAssetKind/3/0 - - https://admin-shell.io/aas/API/GetAllAssetAdministrationShellDescriptorsByAssetType/3/0 - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Limit' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Cursor' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/AssetKind' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/AssetType' - responses: - '200': - description: Requested Asset Administration Shell Descriptors - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/GetAssetAdministrationShellDescriptorsResult' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - post: - tags: - - Asset Administration Shell Registry API - summary: Creates a new Asset Administration Shell Descriptor, i.e. registers an AAS - operationId: PostAssetAdministrationShellDescriptor - x-semanticIds: - - https://admin-shell.io/aas/API/PostAssetAdministrationShellDescriptor/3/0 - requestBody: - description: Asset Administration Shell Descriptor object - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/AssetAdministrationShellDescriptor' - required: true - responses: - '201': - description: Asset Administration Shell Descriptor created successfully - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/AssetAdministrationShellDescriptor' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '409': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/conflict' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /shell-descriptors/{aasIdentifier}: - get: - tags: - - Asset Administration Shell Registry API - summary: Returns a specific Asset Administration Shell Descriptor - operationId: GetAssetAdministrationShellDescriptorById - x-semanticIds: - - https://admin-shell.io/aas/API/GetAssetAdministrationShellDescriptorById/3/0 - parameters: - - name: aasIdentifier - in: path - description: The Asset Administration Shell’s unique id (UTF8-BASE64-URL-encoded) - required: true - style: simple - explode: false - schema: - type: string - format: byte - responses: - '200': - description: Requested Asset Administration Shell Descriptor - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/AssetAdministrationShellDescriptor' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - put: - tags: - - Asset Administration Shell Registry API - summary: Updates an existing Asset Administration Shell Descriptor - operationId: PutAssetAdministrationShellDescriptorById - x-semanticIds: - - https://admin-shell.io/aas/API/PutAssetAdministrationShellDescriptorById/3/0 - parameters: - - name: aasIdentifier - in: path - description: The Asset Administration Shell’s unique id (UTF8-BASE64-URL-encoded) - required: true - style: simple - explode: false - schema: - type: string - format: byte - requestBody: - description: Asset Administration Shell Descriptor object - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/AssetAdministrationShellDescriptor' - required: true - responses: - '204': - description: Asset Administration Shell Descriptor updated successfully - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - delete: - tags: - - Asset Administration Shell Registry API - summary: Deletes an Asset Administration Shell Descriptor, i.e. de-registers an AAS - operationId: DeleteAssetAdministrationShellDescriptorById - x-semanticIds: - - https://admin-shell.io/aas/API/DeleteAssetAdministrationShellDescriptorById/3/0 - parameters: - - name: aasIdentifier - in: path - description: The Asset Administration Shell’s unique id (UTF8-BASE64-URL-encoded) - required: true - style: simple - explode: false - schema: - type: string - format: byte - responses: - '204': - description: Asset Administration Shell Descriptor deleted successfully - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /shell-descriptors/{aasIdentifier}/submodel-descriptors: - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/AssetAdministrationShellIdentifier' - get: - tags: - - Asset Administration Shell Registry API - summary: Returns all Submodel Descriptors - operationId: GetAllSubmodelDescriptorsThroughSuperpath - x-semanticIds: - - https://admin-shell.io/aas/API/GetAllSubmodelDescriptors/3/0 - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Limit' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Cursor' - responses: - '200': - description: Requested Submodel Descriptors - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/GetSubmodelDescriptorsResult' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - post: - tags: - - Asset Administration Shell Registry API - summary: Creates a new Submodel Descriptor, i.e. registers a submodel - operationId: PostSubmodelDescriptor-ThroughSuperpath # TODO - x-semanticIds: - - https://admin-shell.io/aas/API/PostSubmodelDescriptor/3/0 - requestBody: - description: Submodel Descriptor object - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/SubmodelDescriptor' - required: true - responses: - '201': - description: Submodel Descriptor created successfully - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/SubmodelDescriptor' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '409': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/conflict' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /shell-descriptors/{aasIdentifier}/submodel-descriptors/{submodelIdentifier}: - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/AssetAdministrationShellIdentifier' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/SubmodelIdentifier' - get: - tags: - - Asset Administration Shell Registry API - summary: Returns a specific Submodel Descriptor - operationId: GetSubmodelDescriptorByIdThroughSuperpath - x-semanticIds: - - https://admin-shell.io/aas/API/GetSubmodelDescriptorById/3/0 - responses: - '200': - description: Requested Submodel Descriptor - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/SubmodelDescriptor' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - put: - tags: - - Asset Administration Shell Registry API - summary: Updates an existing Submodel Descriptor - operationId: PutSubmodelDescriptorByIdThroughSuperpath - x-semanticIds: - - https://admin-shell.io/aas/API/PutSubmodelDescriptorById/3/0 - requestBody: - description: Submodel Descriptor object - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/SubmodelDescriptor' - required: true - responses: - '204': - description: Submodel Descriptor updated successfully - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - delete: - tags: - - Asset Administration Shell Registry API - summary: Deletes a Submodel Descriptor, i.e. de-registers a submodel - operationId: DeleteSubmodelDescriptorByIdThroughSuperpath - x-semanticIds: - - https://admin-shell.io/aas/API/DeleteSubmodelDescriptorById/3/0 - responses: - '204': - description: Submodel Descriptor deleted successfully - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /submodel-descriptors: - get: - tags: - - Submodel Registry API - summary: Returns all Submodel Descriptors - operationId: GetAllSubmodelDescriptors - x-semanticIds: - - https://admin-shell.io/aas/API/GetAllSubmodelDescriptors/3/0 - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Limit' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Cursor' - responses: - '200': - description: Requested Submodel Descriptors - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/GetSubmodelDescriptorsResult' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - post: - tags: - - Submodel Registry API - summary: Creates a new Submodel Descriptor, i.e. registers a submodel - operationId: PostSubmodelDescriptor - x-semanticIds: - - https://admin-shell.io/aas/API/PostSubmodelDescriptor/3/0 - requestBody: - description: Submodel Descriptor object - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/SubmodelDescriptor' - required: true - responses: - '201': - description: Submodel Descriptor created successfully - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/SubmodelDescriptor' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '409': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/conflict' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /submodel-descriptors/{submodelIdentifier}: - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/SubmodelIdentifier' - get: - tags: - - Submodel Registry API - summary: Returns a specific Submodel Descriptor - operationId: GetSubmodelDescriptorById - x-semanticIds: - - https://admin-shell.io/aas/API/GetSubmodelDescriptorById/3/0 - responses: - '200': - description: Requested Submodel Descriptor - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/SubmodelDescriptor' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - put: - tags: - - Submodel Registry API - summary: Updates an existing Submodel Descriptor - operationId: PutSubmodelDescriptorById - x-semanticIds: - - https://admin-shell.io/aas/API/PutSubmodelDescriptorById/3/0 - requestBody: - description: Submodel Descriptor object - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/SubmodelDescriptor' - required: true - responses: - '204': - description: Submodel Descriptor updated successfully - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - delete: - tags: - - Submodel Registry API - summary: Deletes a Submodel Descriptor, i.e. de-registers a submodel - operationId: DeleteSubmodelDescriptorById - x-semanticIds: - - https://admin-shell.io/aas/API/DeleteSubmodelDescriptorById/3/0 - responses: - '204': - description: Submodel Descriptor deleted successfully - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - /description: - get: - tags: - - Description API - summary: Returns the self-describing information of a network resource (ServiceDescription) - operationId: GetDescription - x-semanticIds: - - https://admin-shell.io/aas/API/Descriptor/GetDescription/3/0 - responses: - '200': - description: Requested Description - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/ServiceDescription' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' \ No newline at end of file diff --git a/RegistryServiceSpecification/V3.0_SSP-002.yaml b/RegistryServiceSpecification/V3.0_SSP-002.yaml deleted file mode 100644 index d9ed27cf..00000000 --- a/RegistryServiceSpecification/V3.0_SSP-002.yaml +++ /dev/null @@ -1,351 +0,0 @@ -openapi: 3.0.3 -info: - title: DotAAS Part 2 | HTTP/REST | Registry Service Specification - description: "The Asset Administration Shell Registry Service Specification as part of Details of the Asset Administration Shell Part 2. Publisher: Industrial Digital Twin Association (IDTA) April 2023" - contact: - name: Industrial Digital Twin Association (IDTA) - email: info@idtwin.org - license: - name: CC BY 4.0 - url: https://creativecommons.org/licenses/by/4.0/ - version: V3.0_SSP-002 -servers: -- url: '{protocol}://{host_name}:{port}/api/{version_prefix}' - variables: - protocol: - description: 'Allows access through http and https (recommended)' - enum: - - 'http' - - 'https' - default: 'https' - host_name: - default: admin-shell.io - description: 'Hostname of server hosting the api' - port: - enum: - - '80' - - '443' - default: '443' - description: '80 is default for http, 443 for https' - version_prefix: - enum: - - 'v3.0' - default: v3.0 -paths: - /shell-descriptors: - get: - tags: - - Asset Administration Shell Registry API - summary: Returns all Asset Administration Shell Descriptors - operationId: GetAllAssetAdministrationShellDescriptors - x-semanticIds: - - https://admin-shell.io/aas/API/GetAllAssetAdministrationShellDescriptors/3/0 - - https://admin-shell.io/aas/API/GetAllAssetAdministrationShellDescriptorsByAssetKind/3/0 - - https://admin-shell.io/aas/API/GetAllAssetAdministrationShellDescriptorsByAssetType/3/0 - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Limit' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Cursor' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/AssetKind' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/AssetType' - responses: - '200': - description: Requested Asset Administration Shell Descriptors - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/GetAssetAdministrationShellDescriptorsResult' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - post: - tags: - - Asset Administration Shell Registry API - summary: Creates a new Asset Administration Shell Descriptor, i.e. registers an AAS - operationId: PostAssetAdministrationShellDescriptor - x-semanticIds: - - https://admin-shell.io/aas/API/PostAssetAdministrationShellDescriptor/3/0 - requestBody: - description: Asset Administration Shell Descriptor object - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/AssetAdministrationShellDescriptor' - required: true - responses: - '201': - description: Asset Administration Shell Descriptor created successfully - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/AssetAdministrationShellDescriptor' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '409': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/conflict' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /shell-descriptors/{aasIdentifier}: - get: - tags: - - Asset Administration Shell Registry API - summary: Returns a specific Asset Administration Shell Descriptor - operationId: GetAssetAdministrationShellDescriptorById - x-semanticIds: - - https://admin-shell.io/aas/API/GetAssetAdministrationShellDescriptorById/3/0 - parameters: - - name: aasIdentifier - in: path - description: The Asset Administration Shell’s unique id (UTF8-BASE64-URL-encoded) - required: true - style: simple - explode: false - schema: - type: string - format: byte - responses: - '200': - description: Requested Asset Administration Shell Descriptor - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/AssetAdministrationShellDescriptor' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - put: - tags: - - Asset Administration Shell Registry API - summary: Updates an existing Asset Administration Shell Descriptor - operationId: PutAssetAdministrationShellDescriptorById - x-semanticIds: - - https://admin-shell.io/aas/API/PutAssetAdministrationShellDescriptorById/3/0 - parameters: - - name: aasIdentifier - in: path - description: The Asset Administration Shell’s unique id (UTF8-BASE64-URL-encoded) - required: true - style: simple - explode: false - schema: - type: string - format: byte - requestBody: - description: Asset Administration Shell Descriptor object - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/AssetAdministrationShellDescriptor' - required: true - responses: - '204': - description: Asset Administration Shell Descriptor updated successfully - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - delete: - tags: - - Asset Administration Shell Registry API - summary: Deletes an Asset Administration Shell Descriptor, i.e. de-registers an AAS - operationId: DeleteAssetAdministrationShellDescriptorById - x-semanticIds: - - https://admin-shell.io/aas/API/DeleteAssetAdministrationShellDescriptorById/3/0 - parameters: - - name: aasIdentifier - in: path - description: The Asset Administration Shell’s unique id (UTF8-BASE64-URL-encoded) - required: true - style: simple - explode: false - schema: - type: string - format: byte - responses: - '204': - description: Asset Administration Shell Descriptor deleted successfully - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /shell-descriptors/{aasIdentifier}/submodel-descriptors: - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/AssetAdministrationShellIdentifier' - get: - tags: - - Asset Administration Shell Registry API - summary: Returns all Submodel Descriptors - operationId: GetAllSubmodelDescriptorsThroughSuperpath - x-semanticIds: - - https://admin-shell.io/aas/API/GetAllSubmodelDescriptors/3/0 - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Limit' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Cursor' - responses: - '200': - description: Requested Submodel Descriptors - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/GetSubmodelDescriptorsResult' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - post: - tags: - - Asset Administration Shell Registry API - summary: Creates a new Submodel Descriptor, i.e. registers a submodel - operationId: PostSubmodelDescriptor-ThroughSuperpath # TODO - x-semanticIds: - - https://admin-shell.io/aas/API/PostSubmodelDescriptor/3/0 - requestBody: - description: Submodel Descriptor object - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/SubmodelDescriptor' - required: true - responses: - '201': - description: Submodel Descriptor created successfully - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/SubmodelDescriptor' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '409': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/conflict' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /shell-descriptors/{aasIdentifier}/submodel-descriptors/{submodelIdentifier}: - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/AssetAdministrationShellIdentifier' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/SubmodelIdentifier' - get: - tags: - - Asset Administration Shell Registry API - summary: Returns a specific Submodel Descriptor - operationId: GetSubmodelDescriptorByIdThroughSuperpath - x-semanticIds: - - https://admin-shell.io/aas/API/GetSubmodelDescriptorById/3/0 - responses: - '200': - description: Requested Submodel Descriptor - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/SubmodelDescriptor' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - put: - tags: - - Asset Administration Shell Registry API - summary: Updates an existing Submodel Descriptor - operationId: PutSubmodelDescriptorByIdThroughSuperpath - x-semanticIds: - - https://admin-shell.io/aas/API/PutSubmodelDescriptorById/3/0 - requestBody: - description: Submodel Descriptor object - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/SubmodelDescriptor' - required: true - responses: - '204': - description: Submodel Descriptor updated successfully - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - delete: - tags: - - Asset Administration Shell Registry API - summary: Deletes a Submodel Descriptor, i.e. de-registers a submodel - operationId: DeleteSubmodelDescriptorByIdThroughSuperpath - x-semanticIds: - - https://admin-shell.io/aas/API/DeleteSubmodelDescriptorById/3/0 - responses: - '204': - description: Submodel Descriptor deleted successfully - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - - /description: - get: - tags: - - Description API - summary: Returns the self-describing information of a network resource (ServiceDescription) - operationId: GetDescription - x-semanticIds: - - https://admin-shell.io/aas/API/Descriptor/GetDescription/3/0 - responses: - '200': - description: Requested Description - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/ServiceDescription' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' \ No newline at end of file diff --git a/RegistryServiceSpecification/V3.0_SSP-003.yaml b/RegistryServiceSpecification/V3.0_SSP-003.yaml deleted file mode 100644 index f561bc13..00000000 --- a/RegistryServiceSpecification/V3.0_SSP-003.yaml +++ /dev/null @@ -1,177 +0,0 @@ -openapi: 3.0.3 -info: - title: DotAAS Part 2 | HTTP/REST | Registry Service Specification - description: "The Read Profile of the Asset Administration Shell Registry Service Specification as part of Details of the Asset Administration Shell Part 2. Publisher: Industrial Digital Twin Association (IDTA) April 2023" - contact: - name: Industrial Digital Twin Association (IDTA) - email: info@idtwin.org - license: - name: CC BY 4.0 - url: https://creativecommons.org/licenses/by/4.0/ - version: V3.0_SSP-003 -servers: -- url: '{protocol}://{host_name}:{port}/api/{version_prefix}' - variables: - protocol: - description: 'Allows access through http and https (recommended)' - enum: - - 'http' - - 'https' - default: 'https' - host_name: - default: admin-shell.io - description: 'Hostname of server hosting the api' - port: - enum: - - '80' - - '443' - default: '443' - description: '80 is default for http, 443 for https' - version_prefix: - enum: - - 'v3.0' - default: v3.0 -paths: - /shell-descriptors: - get: - tags: - - Asset Administration Shell Registry API - summary: Returns all Asset Administration Shell Descriptors - operationId: GetAllAssetAdministrationShellDescriptors - x-semanticIds: - - https://admin-shell.io/aas/API/GetAllAssetAdministrationShellDescriptors/3/0 - - https://admin-shell.io/aas/API/GetAllAssetAdministrationShellDescriptorsByAssetKind/3/0 - - https://admin-shell.io/aas/API/GetAllAssetAdministrationShellDescriptorsByAssetType/3/0 - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Limit' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Cursor' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/AssetKind' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/AssetType' - responses: - '200': - description: Requested Asset Administration Shell Descriptors - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/GetAssetAdministrationShellDescriptorsResult' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /shell-descriptors/{aasIdentifier}: - get: - tags: - - Asset Administration Shell Registry API - summary: Returns a specific Asset Administration Shell Descriptor - operationId: GetAssetAdministrationShellDescriptorById - x-semanticIds: - - https://admin-shell.io/aas/API/GetAssetAdministrationShellDescriptorById/3/0 - parameters: - - name: aasIdentifier - in: path - description: The Asset Administration Shell’s unique id (UTF8-BASE64-URL-encoded) - required: true - style: simple - explode: false - schema: - type: string - format: byte - responses: - '200': - description: Requested Asset Administration Shell Descriptor - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/AssetAdministrationShellDescriptor' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /shell-descriptors/{aasIdentifier}/submodel-descriptors: - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/AssetAdministrationShellIdentifier' - get: - tags: - - Asset Administration Shell Registry API - summary: Returns all Submodel Descriptors - operationId: GetAllSubmodelDescriptorsThroughSuperpath - x-semanticIds: - - https://admin-shell.io/aas/API/GetAllSubmodelDescriptors/3/0 - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Limit' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Cursor' - responses: - '200': - description: Requested Submodel Descriptors - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/GetSubmodelDescriptorsResult' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /shell-descriptors/{aasIdentifier}/submodel-descriptors/{submodelIdentifier}: - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/AssetAdministrationShellIdentifier' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/SubmodelIdentifier' - get: - tags: - - Asset Administration Shell Registry API - summary: Returns a specific Submodel Descriptor - operationId: GetSubmodelDescriptorByIdThroughSuperpath - x-semanticIds: - - https://admin-shell.io/aas/API/GetSubmodelDescriptorById/3/0 - responses: - '200': - description: Requested Submodel Descriptor - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/SubmodelDescriptor' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - - /description: - get: - tags: - - Description API - summary: Returns the self-describing information of a network resource (ServiceDescription) - operationId: GetDescription - x-semanticIds: - - https://admin-shell.io/aas/API/Descriptor/GetDescription/3/0 - responses: - '200': - description: Requested Description - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/ServiceDescription' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' \ No newline at end of file diff --git a/RegistryServiceSpecification/V3.0_SSP-004.yaml b/RegistryServiceSpecification/V3.0_SSP-004.yaml deleted file mode 100644 index 6ddc55fa..00000000 --- a/RegistryServiceSpecification/V3.0_SSP-004.yaml +++ /dev/null @@ -1,182 +0,0 @@ -openapi: 3.0.3 -info: - title: DotAAS Part 2 | HTTP/REST | Registry Service Specification - description: "The Full Profile of the Submodel Registry Service Specification as part of Details of the Asset Administration Shell Part 2. Publisher: Industrial Digital Twin Association (IDTA) April 2023" - contact: - name: Industrial Digital Twin Association (IDTA) - email: info@idtwin.org - license: - name: CC BY 4.0 - url: https://creativecommons.org/licenses/by/4.0/ - version: V3.0_SSP-004 -servers: -- url: '{protocol}://{host_name}:{port}/api/{version_prefix}' - variables: - protocol: - description: 'Allows access through http and https (recommended)' - enum: - - 'http' - - 'https' - default: 'https' - host_name: - default: admin-shell.io - description: 'Hostname of server hosting the api' - port: - enum: - - '80' - - '443' - default: '443' - description: '80 is default for http, 443 for https' - version_prefix: - enum: - - 'v3.0' - default: v3.0 -paths: - /submodel-descriptors: - get: - tags: - - Submodel Registry API - summary: Returns all Submodel Descriptors - operationId: GetAllSubmodelDescriptors - x-semanticIds: - - https://admin-shell.io/aas/API/GetAllSubmodelDescriptors/3/0 - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Limit' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Cursor' - responses: - '200': - description: Requested Submodel Descriptors - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/GetSubmodelDescriptorsResult' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - post: - tags: - - Submodel Registry API - summary: Creates a new Submodel Descriptor, i.e. registers a submodel - operationId: PostSubmodelDescriptor - x-semanticIds: - - https://admin-shell.io/aas/API/PostSubmodelDescriptor/3/0 - requestBody: - description: Submodel Descriptor object - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/SubmodelDescriptor' - required: true - responses: - '201': - description: Submodel Descriptor created successfully - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/SubmodelDescriptor' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '409': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/conflict' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /submodel-descriptors/{submodelIdentifier}: - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/SubmodelIdentifier' - get: - tags: - - Submodel Registry API - summary: Returns a specific Submodel Descriptor - operationId: GetSubmodelDescriptorById - x-semanticIds: - - https://admin-shell.io/aas/API/GetSubmodelDescriptorById/3/0 - responses: - '200': - description: Requested Submodel Descriptor - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/SubmodelDescriptor' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - put: - tags: - - Submodel Registry API - summary: Updates an existing Submodel Descriptor - operationId: PutSubmodelDescriptorById - x-semanticIds: - - https://admin-shell.io/aas/API/PutSubmodelDescriptorById/3/0 - requestBody: - description: Submodel Descriptor object - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/SubmodelDescriptor' - required: true - responses: - '204': - description: Submodel Descriptor updated successfully - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - delete: - tags: - - Submodel Registry API - summary: Deletes a Submodel Descriptor, i.e. de-registers a submodel - operationId: DeleteSubmodelDescriptorById - x-semanticIds: - - https://admin-shell.io/aas/API/DeleteSubmodelDescriptorById/3/0 - responses: - '204': - description: Submodel Descriptor deleted successfully - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - /description: - get: - tags: - - Description API - summary: Returns the self-describing information of a network resource (ServiceDescription) - operationId: GetDescription - x-semanticIds: - - https://admin-shell.io/aas/API/Descriptor/GetDescription/3/0 - responses: - '200': - description: Requested Description - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/ServiceDescription' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' \ No newline at end of file diff --git a/RegistryServiceSpecification/V3.0_SSP-005.yaml b/RegistryServiceSpecification/V3.0_SSP-005.yaml deleted file mode 100644 index 6e242933..00000000 --- a/RegistryServiceSpecification/V3.0_SSP-005.yaml +++ /dev/null @@ -1,109 +0,0 @@ -openapi: 3.0.3 -info: - title: DotAAS Part 2 | HTTP/REST | Registry Service Specification - description: "The Read Profile of the Submodel Registry Service Specification as part of Details of the Asset Administration Shell Part 2. Publisher: Industrial Digital Twin Association (IDTA) April 2023" - contact: - name: Industrial Digital Twin Association (IDTA) - email: info@idtwin.org - license: - name: CC BY 4.0 - url: https://creativecommons.org/licenses/by/4.0/ - version: V3.0_SSP-005 -servers: -- url: '{protocol}://{host_name}:{port}/api/{version_prefix}' - variables: - protocol: - description: 'Allows access through http and https (recommended)' - enum: - - 'http' - - 'https' - default: 'https' - host_name: - default: admin-shell.io - description: 'Hostname of server hosting the api' - port: - enum: - - '80' - - '443' - default: '443' - description: '80 is default for http, 443 for https' - version_prefix: - enum: - - 'v3.0' - default: v3.0 -paths: - /submodel-descriptors: - get: - tags: - - Submodel Registry API - summary: Returns all Submodel Descriptors - operationId: GetAllSubmodelDescriptors - x-semanticIds: - - https://admin-shell.io/aas/API/GetAllSubmodelDescriptors/3/0 - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Limit' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Cursor' - responses: - '200': - description: Requested Submodel Descriptors - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/GetSubmodelDescriptorsResult' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /submodel-descriptors/{submodelIdentifier}: - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/SubmodelIdentifier' - get: - tags: - - Submodel Registry API - summary: Returns a specific Submodel Descriptor - operationId: GetSubmodelDescriptorById - x-semanticIds: - - https://admin-shell.io/aas/API/GetSubmodelDescriptorById/3/0 - responses: - '200': - description: Requested Submodel Descriptor - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/SubmodelDescriptor' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - - /description: - get: - tags: - - Description API - summary: Returns the self-describing information of a network resource (ServiceDescription) - operationId: GetDescription - x-semanticIds: - - https://admin-shell.io/aas/API/Descriptor/GetDescription/3/0 - responses: - '200': - description: Requested Description - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/ServiceDescription' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' \ No newline at end of file diff --git a/RepositoryServiceSpecification/V3.0-MinimalProfile.yaml b/RepositoryServiceSpecification/V3.0-MinimalProfile.yaml deleted file mode 100644 index 68c387c8..00000000 --- a/RepositoryServiceSpecification/V3.0-MinimalProfile.yaml +++ /dev/null @@ -1,626 +0,0 @@ -openapi: 3.0.3 -info: - title: DotAAS Part 2 | HTTP/REST | Repository Service Specification - Minimal Profile - description: The Minimal Profile of the Repository Service Specification as part of Details of the Asset Administration Shell Part 2 - contact: - name: Constantin Ziesche, Andreas Orzelski, Florian Krebs, Bastian Rössl, Manuel Sauer, Jens Vialkowitsch, Michael Hoffmeister, Torben Miny, Sebastian Bader, Marko Ristin, Nico Braunisch - version: V3.0-MinimalProfile - termsOfService: https://github.com/admin-shell-io/aas-specs -servers: -- url: '{protocol}://{host_name}:{port}/api/{version_prefix}' - variables: - protocol: - description: 'Allows access through http and https (recommended)' - enum: - - 'http' - - 'https' - default: 'https' - host_name: - default: admin-shell.io - description: 'Hostname of server hosting the api' - port: - enum: - - '80' - - '443' - default: '443' - description: '80 is default for http, 443 for https' - version_prefix: - enum: - - 'v3.0' - default: v3.0 -paths: - /shells: - get: - tags: - - Asset Administration Shell Repository API - summary: Returns all Asset Administration Shells - operationId: GetAllAssetAdministrationShells - x-semanticIds: - - https://admin-shell.io/aas/API/GetAllAssetAdministrationShells/3/0 - - https://admin-shell.io/aas/API/GetAllAssetAdministrationShellsByAssetId/3/0 - - https://admin-shell.io/aas/API/GetAllAssetAdministrationShellsByIdShort/3/0 - parameters: - - name: assetIds - in: query - description: A list of specific Asset identifiers - required: false - style: form - explode: true - schema: - type: array - items: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0#/components/schemas/SpecificAssetId' - example: '[ { "name": "some-asset-id", "value": "http://example-company.com/myAsset", "externalSubjectId": { "keys": [ { "type": "GlobalReference", "value": "http://example-company.com/example-companys-asset-keys" } ], "type": "GlobalReference" } }, { "name": "some-other-asset-id", "value": "12345ABC", "externalSubjectId": { "keys": [ { "type": "GlobalReference", "value": "http://my-own-company.com/keys" } ], "type": "GlobalReference" } } ]e": "globalAssetId","value": "http://example.company/myAsset", "externalSubjectId": "http://example.company"},{"name": "myOwnInternalAssetId","value": "12345ABC", "externalSubjectId": "http://example.company"}]' - - name: idShort - in: query - description: The Asset Administration Shell’s IdShort - required: false - style: form - explode: true - schema: - type: string - responses: - '200': - description: Requested Asset Administration Shells - content: - application/json: - schema: - type: array - items: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0#/components/schemas/AssetAdministrationShell' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - post: - tags: - - Asset Administration Shell Repository API - summary: Creates a new Asset Administration Shell - operationId: PostAssetAdministrationShell - x-semanticIds: - - https://admin-shell.io/aas/API/PostAssetAdministrationShell/3/0 - requestBody: - description: Asset Administration Shell object - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0#/components/schemas/AssetAdministrationShell' - required: true - responses: - '201': - description: Asset Administration Shell created successfully - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0#/components/schemas/AssetAdministrationShell' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '409': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/conflict' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /shells/{aasIdentifier}: - get: - tags: - - Asset Administration Shell Repository API - summary: Returns a specific Asset Administration Shell - operationId: GetAssetAdministrationShellById - x-semanticIds: - - https://admin-shell.io/aas/API/GetAssetAdministrationShellById/3/0 - parameters: - - name: aasIdentifier - in: path - description: The Asset Administration Shell’s unique id (UTF8-BASE64-URL-encoded) - required: true - style: simple - explode: false - schema: - type: string - format: byte - responses: - '200': - description: Requested Asset Administration Shell - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0#/components/schemas/AssetAdministrationShell' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - put: - tags: - - Asset Administration Shell Repository API - summary: Updates an existing Asset Administration Shell - operationId: PutAssetAdministrationShellById - x-semanticIds: - - https://admin-shell.io/aas/API/PutAssetAdministrationShellById/3/0 - parameters: - - name: aasIdentifier - in: path - description: The Asset Administration Shell’s unique id (UTF8-BASE64-URL-encoded) - required: true - style: simple - explode: false - schema: - type: string - format: byte - requestBody: - description: Asset Administration Shell object - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0#/components/schemas/AssetAdministrationShell' - required: true - responses: - '204': - description: Asset Administration Shell updated successfully - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - delete: - tags: - - Asset Administration Shell Repository API - summary: Deletes an Asset Administration Shell - operationId: DeleteAssetAdministrationShellById - x-semanticIds: - - https://admin-shell.io/aas/API/DeleteAssetAdministrationShellById/3/0 - parameters: - - name: aasIdentifier - in: path - description: The Asset Administration Shell’s unique id (UTF8-BASE64-URL-encoded) - required: true - style: simple - explode: false - schema: - type: string - format: byte - responses: - '204': - description: Asset Administration Shell deleted successfully - '404': - description: Not Found - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/Result' - default: - description: Default error handling for unmentioned status codes - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/Result' - /shells/{aasIdentifier}/submodels: - get: - tags: - - Asset Administration Shell Repository API - summary: Returns all submodel references - operationId: GetAllSubmodelReferences - x-semanticIds: - - https://admin-shell.io/aas/API/GetAllSubmodelReferences/3/0 - parameters: - - name: aasIdentifier - in: path - description: The Asset Administration Shell’s unique id (UTF8-BASE64-URL-encoded) - required: true - style: simple - explode: false - schema: - type: string - format: byte - responses: - '200': - description: Requested submodel references - content: - application/json: - schema: - type: array - items: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0#/components/schemas/Reference' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - post: - tags: - - Asset Administration Shell Repository API - summary: Creates a submodel reference at the Asset Administration Shell - operationId: PostSubmodelReference - x-semanticIds: - - https://admin-shell.io/aas/API/PostSubmodelReference/3/0 - parameters: - - name: aasIdentifier - in: path - description: The Asset Administration Shell’s unique id (UTF8-BASE64-URL-encoded) - required: true - style: simple - explode: false - schema: - type: string - format: byte - requestBody: - description: Reference to the Submodel - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0#/components/schemas/Reference' - required: true - responses: - '201': - description: Submodel reference created successfully - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0#/components/schemas/Reference' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '409': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/conflict' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /shells/{aasIdentifier}/submodels/{submodelIdentifier}: - get: - tags: - - Asset Administration Shell Repository API - summary: Returns the Submodel - operationId: GetSubmodelById_AasRepo - x-semanticIds: - - https://admin-shell.io/aas/API/GetSubmodelById/3/0 - parameters: - - name: aasIdentifier - in: path - description: The Asset Administration Shell’s unique id (UTF8-BASE64-URL-encoded) - required: true - style: simple - explode: false - schema: - type: string - format: byte - - name: submodelIdentifier - in: path - description: The Submodel’s unique id (UTF8-BASE64-URL-encoded) - required: true - style: simple - explode: false - schema: - type: string - format: byte - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Extent' - responses: - '200': - description: Requested Submodel - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0#/components/schemas/Submodel' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - delete: - tags: - - Asset Administration Shell Repository API - summary: Deletes the submodel reference from the Asset Administration Shell. Does not delete the submodel itself! - operationId: DeleteSubmodelReferenceById - x-semanticIds: - - https://admin-shell.io/aas/API/DeleteSubmodelReference/3/0 - parameters: - - name: aasIdentifier - in: path - description: The Asset Administration Shell’s unique id (UTF8-BASE64-URL-encoded) - required: true - style: simple - explode: false - schema: - type: string - format: byte - - name: submodelIdentifier - in: path - description: The Submodel’s unique id (UTF8-BASE64-URL-encoded) - required: true - style: simple - explode: false - schema: - type: string - format: byte - responses: - '204': - description: Submodel reference deleted successfully - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - - /submodels: - get: - tags: - - Submodel Repository API - summary: Returns all Submodels - operationId: GetAllSubmodels - x-semanticIds: - - https://admin-shell.io/aas/API/GetAllSubmodels/3/0 - - https://admin-shell.io/aas/API/GetAllSubmodelsBySemanticId/3/0 - - https://admin-shell.io/aas/API/GetAllSubmodelsByIdShort/3/0 - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/SemanticId' - - name: idShort - in: query - description: The Submodel’s idShort - required: false - style: form - explode: true - schema: - type: string - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Extent' - responses: - '200': - description: Requested Submodels - content: - application/json: - schema: - type: array - items: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0#/components/schemas/Submodel' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - post: - tags: - - Submodel Repository API - summary: Creates a new Submodel - operationId: PostSubmodel - x-semanticIds: - - https://admin-shell.io/aas/API/PostSubmodel/3/0 - requestBody: - description: Submodel object - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0#/components/schemas/Submodel' - required: true - responses: - '201': - description: Submodel created successfully - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0#/components/schemas/Submodel' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '409': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/conflict' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /submodels/{submodelIdentifier}: - get: - tags: - - Submodel Repository API - summary: Returns a specific Submodel - operationId: GetSubmodelById - x-semanticIds: - - https://admin-shell.io/aas/API/GetSubmodelById/3/0 - parameters: - - name: submodelIdentifier - in: path - description: The Submodel’s unique id (UTF8-BASE64-URL-encoded) - required: true - style: simple - explode: false - schema: - type: string - format: byte - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Extent' - responses: - '200': - description: Requested Submodel - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0#/components/schemas/Submodel' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - put: - tags: - - Submodel Repository API - summary: Updates an existing Submodel - operationId: PutSubmodelById - x-semanticIds: - - https://admin-shell.io/aas/API/PutSubmodelById/3/0 - parameters: - - name: submodelIdentifier - in: path - description: The Submodel’s unique id (UTF8-BASE64-URL-encoded) - required: true - style: simple - explode: false - schema: - type: string - format: byte - #- $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Level' - - name: level - in: query - description: Determines the structural depth of the respective resource content - required: false - schema: - type: string - default: deep - enum: - - deep # only 'deep' is allowed for PUT - #- core - requestBody: - description: Submodel object - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0#/components/schemas/Submodel' - required: true - responses: - '204': - description: Submodel updated successfully - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - patch: - tags: - - Submodel Repository API - summary: Updates an existing Submodel - operationId: PatchSubmodelById - x-semanticIds: - - https://admin-shell.io/aas/API/PatchSubmodelById/3/0 - parameters: - - name: submodelIdentifier - in: path - description: The Submodel’s unique id (UTF8-BASE64-URL-encoded) - required: true - style: simple - explode: false - schema: - type: string - format: byte - #- $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Level' - - name: level - in: query - description: Determines the structural depth of the respective resource content - required: false - schema: - type: string - default: core - enum: - #- deep - - core # only 'core' is allowed for PATCH - requestBody: - description: Submodel object - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0#/components/schemas/Submodel' - required: true - responses: - '204': - description: Submodel updated successfully - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - delete: - tags: - - Submodel Repository API - summary: Deletes a Submodel - operationId: DeleteSubmodelById - x-semanticIds: - - https://admin-shell.io/aas/API/DeleteSubmodelById/3/0 - parameters: - - name: submodelIdentifier - in: path - description: The Submodel’s unique id (UTF8-BASE64-URL-encoded) - required: true - style: simple - explode: false - schema: - type: string - format: byte - responses: - '204': - description: Submodel deleted successfully - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /description: - get: - tags: - - Description API - summary: Returns the self-describing information of a network resource (ServiceDescription) - operationId: GetDescription - x-semanticIds: - - https://admin-shell.io/aas/API/Descriptor/GetDescription/3/0 - responses: - '200': - description: Requested Description - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/ServiceDescription' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' \ No newline at end of file diff --git a/RepositoryServiceSpecification/V3.0.yaml b/RepositoryServiceSpecification/V3.0.yaml deleted file mode 100644 index a851e879..00000000 --- a/RepositoryServiceSpecification/V3.0.yaml +++ /dev/null @@ -1,3256 +0,0 @@ -openapi: 3.0.3 -info: - title: DotAAS Part 2 | HTTP/REST | Repository Service Specification - description: "The entire Repository Service Specification as part of Details of the Asset Administration Shell Part 2 - Copyright: Industrial Digital Twin Association (IDTA) 2023" - contact: - name: Industrial Digital Twin Association (IDTA) - email: info@idtwin.org - license: - name: CC BY-SA 4.0 - url: https://creativecommons.org/licenses/by-sa/4.0/ - version: V3.0 - termsOfService: https://github.com/admin-shell-io/aas-specs -servers: -- url: '{protocol}://{host_name}:{port}/api/{version_prefix}' - variables: - protocol: - description: 'Allows access through http and https (recommended)' - enum: - - 'http' - - 'https' - default: 'https' - host_name: - default: admin-shell.io - description: 'Hostname of server hosting the api' - port: - enum: - - '80' - - '443' - default: '443' - description: '80 is default for http, 443 for https' - version_prefix: - enum: - - 'v3.0' - default: v3.0 -paths: - /shells: - get: - tags: - - Asset Administration Shell Repository API - summary: Returns all Asset Administration Shells - operationId: GetAllAssetAdministrationShells - x-semanticIds: - - https://admin-shell.io/aas/API/GetAllAssetAdministrationShells/3/0 - - https://admin-shell.io/aas/API/GetAllAssetAdministrationShellsByAssetId/3/0 - - https://admin-shell.io/aas/API/GetAllAssetAdministrationShellsByIdShort/3/0 - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/AssetIds' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/IdShort' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Limit' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Cursor' - responses: - '200': - description: Requested Asset Administration Shells - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/GetAssetAdministrationShellsResult' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - post: - tags: - - Asset Administration Shell Repository API - summary: Creates a new Asset Administration Shell - operationId: PostAssetAdministrationShell - x-semanticIds: - - https://admin-shell.io/aas/API/PostAssetAdministrationShell/3/0 - requestBody: - description: Asset Administration Shell object - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0#/components/schemas/AssetAdministrationShell' - required: true - responses: - '201': - description: Asset Administration Shell created successfully - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0#/components/schemas/AssetAdministrationShell' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '409': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/conflict' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /shells/$reference: - get: - tags: - - Asset Administration Shell Repository API - summary: Returns References to all Asset Administration Shells - operationId: GetAllAssetAdministrationShells-Reference - x-semanticIds: - - https://admin-shell.io/aas/API/GetAllAssetAdministrationShells/3/0 - - https://admin-shell.io/aas/API/GetAllAssetAdministrationShellsByAssetId/3/0 - - https://admin-shell.io/aas/API/GetAllAssetAdministrationShellsByIdShort/3/0 - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/AssetIds' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/IdShort' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Limit' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Cursor' - responses: - '200': - description: Requested Asset Administration Shells as a list of References - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/GetReferencesResult' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /shells/{aasIdentifier}: - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/AssetAdministrationShellIdentifier' - get: - tags: - - Asset Administration Shell Repository API - summary: Returns a specific Asset Administration Shell - operationId: GetAssetAdministrationShellById - x-semanticIds: - - https://admin-shell.io/aas/API/GetAssetAdministrationShellById/3/0 - responses: - '200': - description: Requested Asset Administration Shell - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0#/components/schemas/AssetAdministrationShell' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - put: - tags: - - Asset Administration Shell Repository API - summary: Updates an existing Asset Administration Shell - operationId: PutAssetAdministrationShellById - x-semanticIds: - - https://admin-shell.io/aas/API/PutAssetAdministrationShellById/3/0 - requestBody: - description: Asset Administration Shell object - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0#/components/schemas/AssetAdministrationShell' - required: true - responses: - '204': - description: Asset Administration Shell updated successfully - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - delete: - tags: - - Asset Administration Shell Repository API - summary: Deletes an Asset Administration Shell - operationId: DeleteAssetAdministrationShellById - x-semanticIds: - - https://admin-shell.io/aas/API/DeleteAssetAdministrationShellById/3/0 - responses: - '204': - description: Asset Administration Shell deleted successfully - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - description: Not Found - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/Result' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - description: Default error handling for unmentioned status codes - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/Result' - /shells/{aasIdentifier}/$reference: - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/AssetAdministrationShellIdentifier' - get: - tags: - - Asset Administration Shell Repository API - summary: Returns a specific Asset Administration Shell as a Reference - operationId: GetAssetAdministrationShellById-Reference - x-semanticIds: - - https://admin-shell.io/aas/API/GetAssetAdministrationShellById/3/0 - responses: - '200': - description: Requested Asset Administration Shell - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0#/components/schemas/Reference' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /shells/{aasIdentifier}/asset-information: - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/AssetAdministrationShellIdentifier' - get: - tags: - - Asset Administration Shell Repository API - summary: Returns the Asset Information - operationId: GetAssetInformation - x-semanticIds: - - https://admin-shell.io/aas/API/GetAssetInformation/3/0 - responses: - '200': - description: Requested Asset Information - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0#/components/schemas/AssetInformation' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - put: - tags: - - Asset Administration Shell Repository API - summary: Updates the Asset Information - operationId: PutAssetInformation - x-semanticIds: - - https://admin-shell.io/aas/API/PutAssetInformation/3/0 - requestBody: - description: Asset Information object - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0#/components/schemas/AssetInformation' - required: true - responses: - '204': - description: Asset Information updated successfully - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /shells/{aasIdentifier}/asset-information/thumbnail: - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/AssetAdministrationShellIdentifier' - get: - tags: - - Asset Administration Shell Repository API - operationId: GetThumbnail - x-semanticIds: - - https://admin-shell.io/aas/API/GetThumbnail/3/0 - responses: - '200': - description: The thumbnail of the Asset Information. - content: - application/octet-stream: - schema: - type: string - format: binary - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - put: - tags: - - Asset Administration Shell Repository API - operationId: PutThumbnail - x-semanticIds: - - https://admin-shell.io/aas/API/PutThumbnail/3/0 - requestBody: - description: Thumbnail to upload - content: - multipart/form-data: - schema: - type: object - properties: - fileName: - type: string - file: - type: string - format: binary - encoding: - file: - contentType: application/octet-stream - required: true - responses: - '204': - description: Thumbnail updated successfully - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - delete: - tags: - - Asset Administration Shell Repository API - operationId: DeleteThumbnail - x-semanticIds: - - https://admin-shell.io/aas/API/DeleteThumbnail/3/0 - responses: - '200': - description: Thumbnail deletion successful - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /shells/{aasIdentifier}/submodel-refs: - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/AssetAdministrationShellIdentifier' - get: - tags: - - Asset Administration Shell Repository API - summary: Returns all submodel references - operationId: GetAllSubmodelReferences - x-semanticIds: - - https://admin-shell.io/aas/API/GetAllSubmodelReferences/3/0 - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Limit' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Cursor' - responses: - '200': - description: Requested submodel references - content: - application/json: - schema: - type: array - items: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/GetReferencesResult' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - post: - tags: - - Asset Administration Shell Repository API - summary: Creates a submodel reference at the Asset Administration Shell - operationId: PostSubmodelReference - x-semanticIds: - - https://admin-shell.io/aas/API/PostSubmodelReference/3/0 - requestBody: - description: Reference to the Submodel - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0#/components/schemas/Reference' - required: true - responses: - '201': - description: Submodel reference created successfully - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0#/components/schemas/Reference' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '409': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/conflict' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /shells/{aasIdentifier}/submodel-refs/{submodelIdentifier}: - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/AssetAdministrationShellIdentifier' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/SubmodelIdentifier' - delete: - tags: - - Asset Administration Shell Repository API - summary: Deletes the submodel reference from the Asset Administration Shell. Does not delete the submodel itself! - operationId: DeleteSubmodelReferenceById - x-semanticIds: - - https://admin-shell.io/aas/API/DeleteSubmodelReference/3/0 - responses: - '204': - description: Submodel reference deleted successfully - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /shells/{aasIdentifier}/submodels/{submodelIdentifier}: - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/AssetAdministrationShellIdentifier' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/SubmodelIdentifier' - get: - tags: - - Asset Administration Shell Repository API - summary: Returns the Submodel - operationId: GetSubmodelById_AasRepository - x-semanticIds: - - https://admin-shell.io/aas/API/GetSubmodel/3/0 - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Level' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Extent' - responses: - '200': - description: Requested Submodel - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0#/components/schemas/Submodel' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - put: - tags: - - Asset Administration Shell Repository API - summary: Updates the Submodel - operationId: PutSubmodelById_AasRepository - x-semanticIds: - - https://admin-shell.io/aas/API/PutSubmodel/3/0 - parameters: - #- $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Level' - - name: level - in: query - description: Determines the structural depth of the respective resource content - required: false - schema: - type: string - default: deep - enum: - - deep # only 'deep' is allowed for PUT - #- core - requestBody: - description: Submodel object - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0#/components/schemas/Submodel' - required: true - responses: - '204': - description: Submodel updated successfully - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - patch: - tags: - - Asset Administration Shell Repository API - summary: Updates the Submodel - operationId: PatchSubmodel - x-semanticIds: - - https://admin-shell.io/aas/API/PutSubmodel/3/0 - parameters: - #- $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Level' - - name: level - in: query - description: Determines the structural depth of the respective resource content - required: false - schema: - type: string - default: core - enum: - #- deep - - core # only 'deep' is allowed for PUT - requestBody: - description: Submodel object - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0#/components/schemas/Submodel' - required: true - responses: - '204': - description: Submodel updated successfully - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /shells/{aasIdentifier}/submodels/{submodelIdentifier}/$metadata: - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/AssetAdministrationShellIdentifier' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/SubmodelIdentifier' - delete: - tags: - - Asset Administration Shell Repository API - summary: Deletes the submodel from the Asset Administration Shell and the Repository. - operationId: DeleteSubmodelById_AasRepository - x-semanticIds: - - https://admin-shell.io/aas/API/DeleteSubmodelById/3/0 - responses: - '204': - description: Submodel deleted successfully - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - get: - tags: - - Asset Administration Shell Repository API - summary: Returns the Submodel's metadata elements - operationId: GetSubmodelById-Metadata_AasRepository - x-semanticIds: - - https://admin-shell.io/aas/API/GetSubmodel/3/0 - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Level' - responses: - '200': - description: Requested Submodel - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/SubmodelMetadata' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - patch: - tags: - - Asset Administration Shell Repository API - summary: Updates the metadata attributes of the Submodel - operationId: PatchSubmodelById-Metadata_AasRepository - x-semanticIds: - - https://admin-shell.io/aas/API/PutSubmodel/3/0 - parameters: - #- $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Level' - - name: level - in: query - description: Determines the structural depth of the respective resource content - required: false - schema: - type: string - default: core - enum: - #- deep - - core # only 'deep' is allowed for PUT - requestBody: - description: Submodel object - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/SubmodelMetadata' - required: true - responses: - '204': - description: Submodel updated successfully - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /shells/{aasIdentifier}/submodels/{submodelIdentifier}/$value: - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/AssetAdministrationShellIdentifier' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/SubmodelIdentifier' - get: - tags: - - Asset Administration Shell Repository API - summary: Returns the Submodel's ValueOnly representation - operationId: GetSubmodelById-ValueOnly_AasRepository - x-semanticIds: - - https://admin-shell.io/aas/API/GetSubmodel/3/0 - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Level' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Extent' - responses: - '200': - description: Requested Submodel - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/SubmodelValue' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - patch: - tags: - - Asset Administration Shell Repository API - summary: Updates teh values of the Submodel - operationId: PatchSubmodelById-ValueOnly_AasRepository - x-semanticIds: - - https://admin-shell.io/aas/API/PutSubmodel/3/0 - parameters: - #- $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Level' - - name: level - in: query - description: Determines the structural depth of the respective resource content - required: false - schema: - type: string - default: core - enum: - #- deep - - core # only 'deep' is allowed for PUT - requestBody: - description: Submodel object in the ValueOnly representation - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/SubmodelValue' - required: true - responses: - '204': - description: Submodel updated successfully - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /shells/{aasIdentifier}/submodels/{submodelIdentifier}/$reference: - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/AssetAdministrationShellIdentifier' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/SubmodelIdentifier' - get: - tags: - - Asset Administration Shell Repository API - summary: Returns the Submodel as a Reference - operationId: GetSubmodelById-Reference_AasRepository - x-semanticIds: - - https://admin-shell.io/aas/API/GetSubmodel/3/0 - parameters: - #- $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Level' - - name: level # TODO: no level for GetSubmodel-Reference? - in: query - description: Determines the structural depth of the respective resource content - required: false - schema: - type: string - default: core - enum: - # - deep - - core # only 'core' is allowed for Content=Reference - responses: - '200': - description: Requested Submodel as a Reference - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0#/components/schemas/Reference' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - - /shells/{aasIdentifier}/submodels/{submodelIdentifier}/$path: - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/AssetAdministrationShellIdentifier' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/SubmodelIdentifier' - get: - tags: - - Asset Administration Shell Repository API - summary: Returns the Submodel's metadata elements - operationId: GetSubmodelById-Path_AasRepository - x-semanticIds: - - https://admin-shell.io/aas/API/GetSubmodel/3/0 - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Level' - responses: - '200': - description: Requested Submodel in Path notation - content: - application/json: - schema: - type: array - items: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/PathItem' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /shells/{aasIdentifier}/submodels/{submodelIdentifier}/submodel-elements: - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/AssetAdministrationShellIdentifier' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/SubmodelIdentifier' - get: - tags: - - Asset Administration Shell Repository API - summary: Returns all submodel elements including their hierarchy - operationId: GetAllSubmodelElements_AasRepository - x-semanticIds: - - https://admin-shell.io/aas/API/GetAllSubmodelElements/3/0 - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Limit' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Cursor' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Level' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Extent' - responses: - '200': - description: List of found submodel elements - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/GetSubmodelElementsResult' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - post: - tags: - - Asset Administration Shell Repository API - summary: Creates a new submodel element - operationId: PostSubmodelElement - x-semanticIds: - - https://admin-shell.io/aas/API/PostSubmodelElement/3/0 - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Level' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Extent' - requestBody: - description: Requested submodel element - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0#/components/schemas/SubmodelElement' - required: true - responses: - '201': - description: Submodel element created successfully - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0#/components/schemas/SubmodelElement' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '409': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/conflict' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /shells/{aasIdentifier}/submodels/{submodelIdentifier}/submodel-elements/$metadata: - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/AssetAdministrationShellIdentifier' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/SubmodelIdentifier' - get: - tags: - - Asset Administration Shell Repository API - summary: Returns all submodel elements including their hierarchy - operationId: GetAllSubmodelElements-Metadata - x-semanticIds: - - https://admin-shell.io/aas/API/GetAllSubmodelElements/3/0 - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Limit' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Cursor' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Level' - responses: - '200': - description: List of found submodel elements - content: - application/json: - schema: - type: array - items: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/GetSubmodelElementsMetadataResult' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /shells/{aasIdentifier}/submodels/{submodelIdentifier}/submodel-elements/$value: - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/AssetAdministrationShellIdentifier' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/SubmodelIdentifier' - get: - tags: - - Asset Administration Shell Repository API - summary: Returns all submodel elements including their hierarchy in the ValueOnly representation - operationId: GetAllSubmodelElements-ValueOnly - x-semanticIds: - - https://admin-shell.io/aas/API/GetAllSubmodelElements/3/0 - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Limit' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Cursor' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Level' - responses: - '200': - description: List of found submodel elements in their ValueOnly representation - content: - application/json: - schema: - type: array - items: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/GetSubmodelElementsValueResult' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /shells/{aasIdentifier}/submodels/{submodelIdentifier}/submodel-elements/$reference: - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/AssetAdministrationShellIdentifier' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/SubmodelIdentifier' - get: - tags: - - Asset Administration Shell Repository API - summary: Returns all submodel elements as a list of References - operationId: GetAllSubmodelElements-Reference - x-semanticIds: - - https://admin-shell.io/aas/API/GetAllSubmodelElements/3/0 - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Limit' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Cursor' - #- $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Level' - - name: level - in: query - description: Determines the structural depth of the respective resource content - required: false - schema: - type: string - default: core - enum: - # - deep - - core # only 'core' is allowed for Content=Reference - responses: - '200': - description: List of References of the found submodel elements - content: - application/json: - schema: - type: array - items: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/GetReferencesResult' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /shells/{aasIdentifier}/submodels/{submodelIdentifier}/submodel-elements/$path: - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/AssetAdministrationShellIdentifier' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/SubmodelIdentifier' - get: - tags: - - Asset Administration Shell Repository API - summary: Returns all submodel elements including their hierarchy - operationId: GetAllSubmodelElements-Path - x-semanticIds: - - https://admin-shell.io/aas/API/GetAllSubmodelElements/3/0 - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Limit' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Cursor' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Level' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Extent' - responses: - '200': - description: List of found submodel elements in the Path notation - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/GetPathItemsResult' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /shells/{aasIdentifier}/submodels/{submodelIdentifier}/submodel-elements/{idShortPath}: - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/AssetAdministrationShellIdentifier' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/SubmodelIdentifier' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/IdShortPath' - get: - tags: - - Asset Administration Shell Repository API - summary: Returns a specific submodel element from the Submodel at a specified - path - operationId: GetSubmodelElementByPath - x-semanticIds: - - https://admin-shell.io/aas/API/GetSubmodelElementByPath/3/0 - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Limit' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Cursor' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Level' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Extent' - responses: - '200': - description: Requested submodel element - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/GetSubmodelElementsResult' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - post: - tags: - - Asset Administration Shell Repository API - summary: Creates a new submodel element at a specified path within submodel elements hierarchy - operationId: PostSubmodelElementByPath - x-semanticIds: - - https://admin-shell.io/aas/API/PostSubmodelElementByPath/3/0 - requestBody: - description: Requested submodel element - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0#/components/schemas/SubmodelElement' - required: true - responses: - '201': - description: Submodel element created successfully - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0#/components/schemas/SubmodelElement' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '409': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/conflict' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - put: - tags: - - Asset Administration Shell Repository API - summary: Updates an existing submodel element at a specified path within submodel elements hierarchy - operationId: PutSubmodelElementByPath - x-semanticIds: - - https://admin-shell.io/aas/API/PutSubmodelElementByPath/3/0 - - https://admin-shell.io/aas/API/SetSubmodelElementValueByPath/3/0 - requestBody: - description: Requested submodel element - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0#/components/schemas/SubmodelElement' - required: true - responses: - '204': - description: Submodel element updated successfully - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - patch: - tags: - - Asset Administration Shell Repository API - summary: Updates an existing submodel element value at a specified path within submodel elements hierarchy - operationId: PatchSubmodelElementValueByPath - x-semanticIds: - - https://admin-shell.io/aas/API/PatchSubmodelElementByPath/3/0 - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Level' - requestBody: - description: The updated value of the submodel element - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0#/components/schemas/SubmodelElement' - required: true - responses: - '204': - description: Submodel element updated successfully - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - delete: - tags: - - Asset Administration Shell Repository API - summary: Deletes a submodel element at a specified path within the submodel elements hierarchy - operationId: DeleteSubmodelElementByPath - x-semanticIds: - - https://admin-shell.io/aas/API/DeleteSubmodelElementByPath/3/0 - responses: - '204': - description: Submodel element deleted successfully - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /shells/{aasIdentifier}/submodels/{submodelIdentifier}/submodel-elements/{idShortPath}/$metadata: - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/AssetAdministrationShellIdentifier' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/SubmodelIdentifier' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/IdShortPath' - get: - tags: - - Asset Administration Shell Repository API - summary: Returns the metadata attributes if a specific submodel element from the Submodel at a specified - path - operationId: GetSubmodelElementByPath-Metadata - x-semanticIds: - - https://admin-shell.io/aas/API/GetSubmodelElementByPath/3/0 - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Limit' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Cursor' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Level' - responses: - '200': - description: Requested submodel element - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/GetSubmodelElementsMetadataResult' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - patch: - tags: - - Asset Administration Shell Repository API - summary: Updates the metadata attributes of an existing submodel element value at a specified path within submodel elements hierarchy - operationId: PatchSubmodelElementValueByPath-Metadata - x-semanticIds: - - https://admin-shell.io/aas/API/PatchSubmodelElementByPath/3/0 - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Level' - requestBody: - description: The updated metadata attributes of the submodel element - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/SubmodelElementMetadata' - required: true - responses: - '204': - description: Submodel element updated successfully - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /shells/{aasIdentifier}/submodels/{submodelIdentifier}/submodel-elements/{idShortPath}/$value: - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/AssetAdministrationShellIdentifier' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/SubmodelIdentifier' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/IdShortPath' - get: - tags: - - Asset Administration Shell Repository API - summary: Returns a specific submodel element from the Submodel at a specified - path in the ValueOnly representation - operationId: GetSubmodelElementByPath-ValueOnly - x-semanticIds: - - https://admin-shell.io/aas/API/GetSubmodelElementByPath/3/0 - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Limit' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Cursor' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Level' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Extent' - responses: - '200': - description: Requested submodel element in its ValueOnly representation - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/GetSubmodelElementsValueResult' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - patch: - tags: - - Asset Administration Shell Repository API - summary: Updates the value of an existing submodel element value at a specified path within submodel elements hierarchy - operationId: PatchSubmodelElementValueByPath-ValueOnly - x-semanticIds: - - https://admin-shell.io/aas/API/PatchSubmodelElementByPath/3/0 - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Level' - requestBody: - description: The updated value of the submodel element - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/SubmodelElementValue' - required: true - responses: - '204': - description: Submodel element updated successfully - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /shells/{aasIdentifier}/submodels/{submodelIdentifier}/submodel-elements/{idShortPath}/$reference: - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/AssetAdministrationShellIdentifier' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/SubmodelIdentifier' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/IdShortPath' - get: - tags: - - Asset Administration Shell Repository API - summary: Returns the Reference of a specific submodel element from the Submodel at a specified path - operationId: GetSubmodelElementByPath-Reference - x-semanticIds: - - https://admin-shell.io/aas/API/GetSubmodelElementByPath/3/0 - parameters: - #- $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Level' - - name: level - in: query - description: Determines the structural depth of the respective resource content - required: false - schema: - type: string - default: core - enum: - # - deep - - core # only 'core' is allowed for Content=Reference - responses: - '200': - description: Requested submodel element in its ValueOnly representation - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0#/components/schemas/Reference' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /shells/{aasIdentifier}/submodels/{submodelIdentifier}/submodel-elements/{idShortPath}/$path: - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/AssetAdministrationShellIdentifier' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/SubmodelIdentifier' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/IdShortPath' - get: - tags: - - Asset Administration Shell Repository API - summary: Returns a specific submodel element from the Submodel at a specified path in the Path notation - operationId: GetSubmodelElementByPath-Path - x-semanticIds: - - https://admin-shell.io/aas/API/GetSubmodelElementByPath/3/0 - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Level' - responses: - '200': - description: Requested submodel element in the Path notation - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/PathItem' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /shells/{aasIdentifier}/submodels/{submodelIdentifier}/submodel-elements/{idShortPath}/attachment: - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/AssetAdministrationShellIdentifier' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/SubmodelIdentifier' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/IdShortPath' - get: - tags: - - Asset Administration Shell Repository API - summary: Downloads file content from a specific submodel element from the Submodel at a specified path - operationId: GetFileByPath - x-semanticIds: - - https://admin-shell.io/aas/API/GetFileByPath/3/0 - responses: - '200': - description: Requested file - headers: - Content-Disposition: - schema: - type: string - description: In order to physically download the file usually set to attachment with a filename - example: 'attachment; filename="filename.jpg"' - content: - application/octet-stream: - schema: - type: string - format: binary - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - put: - tags: - - Asset Administration Shell Repository API - summary: Uploads file content to an existing submodel element at a specified path within submodel elements hierarchy - operationId: PutFileByPath - x-semanticIds: - - https://admin-shell.io/aas/API/PutFileByPath/3/0 - requestBody: - description: File to upload - content: - multipart/form-data: - schema: - type: object - properties: - fileName: - type: string - file: - type: string - format: binary - encoding: - file: - contentType: application/octet-stream - required: true - responses: - '204': - description: Submodel element updated successfully - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - delete: - tags: - - Asset Administration Shell Repository API - summary: Deletes file content of an existing submodel element at a specified path within submodel elements hierarchy - operationId: DeleteFileByPath - x-semanticIds: - - https://admin-shell.io/aas/API/DeleteFileByPath/3/0 - responses: - '200': - description: Submodel element updated successfully - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /shells/{aasIdentifier}/submodels/{submodelIdentifier}/submodel-elements/{idShortPath}/invoke: - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/AssetAdministrationShellIdentifier' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/SubmodelIdentifier' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/IdShortPath' - post: - tags: - - Asset Administration Shell Repository API - summary: Synchronously or asynchronously invokes an Operation at a specified path - operationId: InvokeOperation - x-semanticIds: - - https://admin-shell.io/aas/API/InvokeOperationSync/3/0 - - https://admin-shell.io/aas/API/InvokeOperationAsync/3/0 - parameters: - - name: async - in: query - description: Determines whether an operation invocation is performed asynchronously or synchronously - schema: - type: boolean - default: false - requestBody: - description: Operation request object - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/OperationRequest' - required: true - responses: - '200': - description: Operation result object - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/OperationResult' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /shells/{aasIdentifier}/submodels/{submodelIdentifier}/submodel-elements/{idShortPath}/invoke/$value: - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/AssetAdministrationShellIdentifier' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/SubmodelIdentifier' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/IdShortPath' - post: - tags: - - Asset Administration Shell Repository API - summary: Synchronously or asynchronously invokes an Operation at a specified path - operationId: InvokeOperation-ValueOnly - x-semanticIds: - - https://admin-shell.io/aas/API/InvokeOperationSync/3/0 - - https://admin-shell.io/aas/API/InvokeOperationAsync/3/0 - parameters: - - name: async - in: query - description: Determines whether an operation invocation is performed asynchronously or synchronously - schema: - type: boolean - default: false - requestBody: - description: Operation request object - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/OperationRequestValueOnly' - required: true - responses: - '200': - description: Operation result object - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/OperationResultValueOnly' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /shells/{aasIdentifier}/submodels/{submodelIdentifier}/submodel-elements/{idShortPath}/operation-results/{handleId}: - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/AssetAdministrationShellIdentifier' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/SubmodelIdentifier' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/IdShortPath' - get: - tags: - - Asset Administration Shell Repository API - summary: Returns the Operation result of an asynchronous invoked Operation - operationId: GetOperationAsyncResult - x-semanticIds: - - https://admin-shell.io/aas/API/GetOperationAsyncResult/3/0 - parameters: - - name: handleId - in: path - description: The returned handle id of an operation’s asynchronous invocation used to request the current state of the operation’s execution (UTF8-BASE64-URL-encoded) - required: true - style: simple - explode: false - schema: - type: string - format: byte - responses: - '200': - description: Operation result object - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/OperationResult' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /shells/{aasIdentifier}/submodels/{submodelIdentifier}/submodel-elements/{idShortPath}/operation-results/{handleId}/$value: - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/AssetAdministrationShellIdentifier' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/SubmodelIdentifier' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/IdShortPath' - get: - tags: - - Asset Administration Shell Repository API - summary: Returns the ValueOnly notation of the Operation result of an asynchronous invoked Operation - operationId: GetOperationAsyncResult-ValueOnly - x-semanticIds: - - https://admin-shell.io/aas/API/GetOperationAsyncResult/3/0 - parameters: - - name: handleId - in: path - description: The returned handle id of an operation’s asynchronous invocation used to request the current state of the operation’s execution (UTF8-BASE64-URL-encoded) - required: true - style: simple - explode: false - schema: - type: string - format: byte - responses: - '200': - description: Operation result object - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/OperationResultValueOnly' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - - /submodels: - get: - tags: - - Submodel Repository API - summary: Returns all Submodels - operationId: GetAllSubmodels - x-semanticIds: - - https://admin-shell.io/aas/API/GetAllSubmodels/3/0 - - https://admin-shell.io/aas/API/GetAllSubmodelsBySemanticId/3/0 - - https://admin-shell.io/aas/API/GetAllSubmodelsByIdShort/3/0 - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/SemanticId' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/IdShort' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Limit' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Cursor' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Level' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Extent' - responses: - '200': - description: Requested Submodels - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/GetSubmodelsResult' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - post: - tags: - - Submodel Repository API - summary: Creates a new Submodel - operationId: PostSubmodel - x-semanticIds: - - https://admin-shell.io/aas/API/PostSubmodel/3/0 - requestBody: - description: Submodel object - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0#/components/schemas/Submodel' - required: true - responses: - '201': - description: Submodel created successfully - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0#/components/schemas/Submodel' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '409': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/conflict' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /submodels/$metadata: - get: - tags: - - Submodel Repository API - summary: Returns the metadata attributes of all Submodels - operationId: GetAllSubmodels-Metadata - x-semanticIds: - - https://admin-shell.io/aas/API/GetAllSubmodels/3/0 - - https://admin-shell.io/aas/API/GetAllSubmodelsBySemanticId/3/0 - - https://admin-shell.io/aas/API/GetAllSubmodelsByIdShort/3/0 - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/SemanticId' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/IdShort' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Limit' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Cursor' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Level' - responses: - '200': - description: Requested Submodels - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/GetSubmodelsMetadataResult' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /submodels/$value: - get: - tags: - - Submodel Repository API - summary: Returns all Submodels in their ValueOnly representation - operationId: GetAllSubmodels-ValueOnly - x-semanticIds: - - https://admin-shell.io/aas/API/GetAllSubmodels/3/0 - - https://admin-shell.io/aas/API/GetAllSubmodelsBySemanticId/3/0 - - https://admin-shell.io/aas/API/GetAllSubmodelsByIdShort/3/0 - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/SemanticId' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/IdShort' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Limit' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Cursor' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Level' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Extent' - responses: - '200': - description: Requested Submodels - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/GetSubmodelsValueResult' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /submodels/$reference: - get: - tags: - - Submodel Repository API - summary: Returns the References for all Submodels - operationId: GetAllSubmodels-Reference - x-semanticIds: - - https://admin-shell.io/aas/API/GetAllSubmodels/3/0 - - https://admin-shell.io/aas/API/GetAllSubmodelsBySemanticId/3/0 - - https://admin-shell.io/aas/API/GetAllSubmodelsByIdShort/3/0 - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/SemanticId' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/IdShort' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Limit' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Cursor' - #- $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Level' - - name: level - in: query - description: Determines the structural depth of the respective resource content - required: false - schema: - type: string - default: core - enum: - # - deep - - core # only 'core' is allowed for Content=Reference - responses: - '200': - description: References of the requested Submodels - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/GetReferencesResult' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /submodels/$path: - get: - tags: - - Submodel Repository API - summary: Returns all Submodels in the Path notation - operationId: GetAllSubmodels-Path - x-semanticIds: - - https://admin-shell.io/aas/API/GetAllSubmodels/3/0 - - https://admin-shell.io/aas/API/GetAllSubmodelsBySemanticId/3/0 - - https://admin-shell.io/aas/API/GetAllSubmodelsByIdShort/3/0 - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/SemanticId' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/IdShort' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Limit' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Cursor' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Level' - responses: - '200': - description: Requested Submodels - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/GetPathItemsResult' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /submodels/{submodelIdentifier}: - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/SubmodelIdentifier' - get: - tags: - - Submodel Repository API - summary: Returns a specific Submodel - operationId: GetSubmodelById - x-semanticIds: - - https://admin-shell.io/aas/API/GetSubmodelById/3/0 - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Level' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Extent' - responses: - '200': - description: Requested Submodel - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0#/components/schemas/Submodel' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - put: - tags: - - Submodel Repository API - summary: Updates an existing Submodel - operationId: PutSubmodelById - x-semanticIds: - - https://admin-shell.io/aas/API/PutSubmodelById/3/0 - parameters: - #- $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Level' - - name: level - in: query - description: Determines the structural depth of the respective resource content - required: false - schema: - type: string - default: deep - enum: - - deep # only 'deep' is allowed for PUT - #- core - requestBody: - description: Submodel object - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0#/components/schemas/Submodel' - required: true - responses: - '204': - description: Submodel updated successfully - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - patch: - tags: - - Submodel Repository API - summary: Updates an existing Submodel - operationId: PatchSubmodelById - x-semanticIds: - - https://admin-shell.io/aas/API/PatchSubmodelById/3/0 - parameters: - #- $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Level' - - name: level - in: query - description: Determines the structural depth of the respective resource content - required: false - schema: - type: string - default: core - enum: - #- deep - - core # only 'core' is allowed for PATCH - requestBody: - description: Submodel object - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0#/components/schemas/Submodel' - required: true - responses: - '204': - description: Submodel updated successfully - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - delete: - tags: - - Submodel Repository API - summary: Deletes a Submodel - operationId: DeleteSubmodelById - x-semanticIds: - - https://admin-shell.io/aas/API/DeleteSubmodelById/3/0 - responses: - '204': - description: Submodel deleted successfully - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /submodels/{submodelIdentifier}/$metadata: - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/SubmodelIdentifier' - get: - tags: - - Submodel Repository API - summary: Returns the metadata attributes of a specific Submodel - operationId: GetSubmodelById-Metadata - x-semanticIds: - - https://admin-shell.io/aas/API/GetSubmodelById/3/0 - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Level' - responses: - '200': - description: Requested Submodel in the metadata representation - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/SubmodelMetadata' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - patch: - tags: - - Submodel Repository API - summary: Updates the metadata attributes of an existing Submodel - operationId: PatchSubmodelById-Metadata - x-semanticIds: - - https://admin-shell.io/aas/API/PatchSubmodelById/3/0 - parameters: - #- $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Level' - - name: level - in: query - description: Determines the structural depth of the respective resource content - required: false - schema: - type: string - default: core - enum: - #- deep - - core # only 'core' is allowed for PATCH - requestBody: - description: The metadata attributes of the Submodel object - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/SubmodelMetadata' - required: true - responses: - '204': - description: Submodel updated successfully - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /submodels/{submodelIdentifier}/$value: - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/SubmodelIdentifier' - get: - tags: - - Submodel Repository API - summary: Returns a specific Submodel in the ValueOnly representation - operationId: GetSubmodelById-ValueOnly - x-semanticIds: - - https://admin-shell.io/aas/API/GetSubmodelById/3/0 - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Level' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Extent' - responses: - '200': - description: Requested Submodel - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/SubmodelValue' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - patch: - tags: - - Submodel Repository API - summary: Updates the values of an existing Submodel - operationId: PatchSubmodelById-ValueOnly - x-semanticIds: - - https://admin-shell.io/aas/API/PatchSubmodelById/3/0 - parameters: - #- $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Level' - - name: level - in: query - description: Determines the structural depth of the respective resource content - required: false - schema: - type: string - default: core - enum: - #- deep - - core # only 'core' is allowed for PATCH - requestBody: - description: Submodel object in its ValueOnly representation - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/SubmodelValue' - required: true - responses: - '204': - description: Submodel updated successfully - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /submodels/{submodelIdentifier}/$reference: - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/SubmodelIdentifier' - get: - tags: - - Submodel Repository API - summary: Returns the Reference of a specific Submodel - operationId: GetSubmodelById-Reference - x-semanticIds: - - https://admin-shell.io/aas/API/GetSubmodelById/3/0 - parameters: - #- $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Level' - - name: level - in: query - description: Determines the structural depth of the respective resource content - required: false - schema: - type: string - default: core - enum: - # - deep - - core # only 'core' is allowed for Content=Reference - responses: - '200': - description: Requested Submodel - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0#/components/schemas/Reference' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /submodels/{submodelIdentifier}/$path: - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/SubmodelIdentifier' - get: - tags: - - Submodel Repository API - summary: Returns a specific Submodel in the Path notation - operationId: GetSubmodelById-Path - x-semanticIds: - - https://admin-shell.io/aas/API/GetSubmodelById/3/0 - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Level' - responses: - '200': - description: Requested Submodel - content: - application/json: - schema: - type: array - items: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/PathItem' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /submodels/{submodelIdentifier}/submodel-elements: - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/SubmodelIdentifier' - get: - tags: - - Submodel Repository API - summary: Returns all submodel elements including their hierarchy - operationId: GetAllSubmodelElements - x-semanticIds: - - https://admin-shell.io/aas/API/GetAllSubmodelElements/3/0 - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Limit' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Cursor' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Level' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Extent' - responses: - '200': - description: List of found submodel elements - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/GetSubmodelElementsResult' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - description: Default error handling for unmentioned status codes - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/Result' - post: - tags: - - Submodel Repository API - summary: Creates a new submodel element - operationId: PostSubmodelElement_SubmodelRepo #TODO - x-semanticIds: - - https://admin-shell.io/aas/API/PostSubmodelElement/3/0 - requestBody: - description: Requested submodel element - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0#/components/schemas/SubmodelElement' - required: true - responses: - '201': - description: Submodel element created successfully - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0#/components/schemas/SubmodelElement' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '409': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/conflict' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /submodels/{submodelIdentifier}/submodel-elements/$metadata: - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/SubmodelIdentifier' - get: - tags: - - Submodel Repository API - summary: Returns the metadata attributes of all submodel elements including their hierarchy - operationId: GetAllSubmodelElements-Metadata_SubmodelRepo #TODO - x-semanticIds: - - https://admin-shell.io/aas/API/GetAllSubmodelElements/3/0 - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Limit' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Cursor' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Level' - responses: - '200': - description: List of found submodel elements - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/GetSubmodelElementsMetadataResult' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /submodels/{submodelIdentifier}/submodel-elements/$value: - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/SubmodelIdentifier' - get: - tags: - - Submodel Repository API - summary: Returns all submodel elements including their hierarchy in the ValueOnly representation - operationId: GetAllSubmodelElements-ValueOnly_SubmodelRepo # TODO - x-semanticIds: - - https://admin-shell.io/aas/API/GetAllSubmodelElements/3/0 - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Limit' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Cursor' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Level' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Extent' - responses: - '200': - description: List of found submodel elements - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/GetSubmodelElementsValueResult' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /submodels/{submodelIdentifier}/submodel-elements/$reference: - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/SubmodelIdentifier' - get: - tags: - - Submodel Repository API - summary: Returns the References of all submodel elements - operationId: GetAllSubmodelElements-Reference_SubmodelRepo # TODO - x-semanticIds: - - https://admin-shell.io/aas/API/GetAllSubmodelElements/3/0 - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Limit' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Cursor' - #- $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Level' - - name: level - in: query - description: Determines the structural depth of the respective resource content - required: false - schema: - type: string - default: core - enum: - # - deep - - core # only 'core' is allowed for Content=Reference - responses: - '200': - description: List of found submodel elements - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/GetReferencesResult' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /submodels/{submodelIdentifier}/submodel-elements/$path: - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/SubmodelIdentifier' - get: - tags: - - Submodel Repository API - summary: Returns all submodel elements including their hierarchy in the Path notation - operationId: GetAllSubmodelElements-Path_SubmodelRepo # TODO - x-semanticIds: - - https://admin-shell.io/aas/API/GetAllSubmodelElements/3/0 - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Limit' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Cursor' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Level' - responses: - '200': - description: List of found submodel elements in the Path notation - content: - application/json: - schema: - type: array - items: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/GetPathItemsResult' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /submodels/{submodelIdentifier}/submodel-elements/{idShortPath}: - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/SubmodelIdentifier' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/IdShortPath' - get: - tags: - - Submodel Repository API - summary: Returns a specific submodel element from the Submodel at a specified - path - operationId: GetSubmodelElementByPath_SubmodelRepo # TODO - x-semanticIds: - - https://admin-shell.io/aas/API/GetSubmodelElementByPath/3/0 - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Level' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Extent' - responses: - '200': - description: Requested submodel element - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0#/components/schemas/SubmodelElement' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - post: - tags: - - Submodel Repository API - summary: Creates a new submodel element at a specified path within submodel elements hierarchy - operationId: PostSubmodelElementByPath_SubmodelRepo # TODO - x-semanticIds: - - https://admin-shell.io/aas/API/PostSubmodelElementByPath/3/0 - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Level' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Extent' - requestBody: - description: Requested submodel element - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0#/components/schemas/SubmodelElement' - required: true - responses: - '201': - description: Submodel element created successfully - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0#/components/schemas/SubmodelElement' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '409': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/conflict' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - put: - tags: - - Submodel Repository API - summary: Updates an existing submodel element at a specified path within submodel elements hierarchy - operationId: PutSubmodelElementByPath_SubmodelRepo # TODO - x-semanticIds: - - https://admin-shell.io/aas/API/PutSubmodelElementByPath/3/0 - - https://admin-shell.io/aas/API/SetSubmodelElementValueByPath/3/0 - parameters: - #- $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Level' - - name: level - in: query - description: Determines the structural depth of the respective resource content - required: false - schema: - type: string - default: deep - enum: - - deep # only 'deep' is allowed for PUT - #- core - requestBody: - description: Requested submodel element - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0#/components/schemas/SubmodelElement' - required: true - responses: - '204': - description: Submodel element updated successfully - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - patch: - tags: - - Submodel Repository API - summary: Updates an existing SubmodelElement - operationId: PatchSubmodelElementByPath_SubmodelRepo # TODO - x-semanticIds: - - https://admin-shell.io/aas/API/PatchSubmodelById/3/0 - parameters: - #- $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Level' - - name: level - in: query - description: Determines the structural depth of the respective resource content - required: false - schema: - type: string - default: core - enum: - #- deep - - core # only 'core' is allowed for PATCH - requestBody: - description: SubmodelElement object - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0#/components/schemas/SubmodelElement' - required: true - responses: - '204': - description: SubmodelElement updated successfully - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - delete: - tags: - - Submodel Repository API - summary: Deletes a submodel element at a specified path within the submodel elements hierarchy - operationId: DeleteSubmodelElementByPath_SubmodelRepo # TODO - x-semanticIds: - - https://admin-shell.io/aas/API/DeleteSubmodelElementByPath/3/0 - responses: - '204': - description: Submodel element deleted successfully - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /submodels/{submodelIdentifier}/submodel-elements/{idShortPath}/$metadata: - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/SubmodelIdentifier' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/IdShortPath' - get: - tags: - - Submodel Repository API - summary: Returns the matadata attributes of a specific submodel element from the Submodel at a specified - path - operationId: GetSubmodelElementByPath-Metadata_SubmodelRepo # TODO - x-semanticIds: - - https://admin-shell.io/aas/API/GetSubmodelElementByPath/3/0 - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Level' - responses: - '200': - description: Metadata attributes of the requested submodel element - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/SubmodelElementMetadata' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - patch: - tags: - - Submodel Repository API - summary: Updates the metadata attributes an existing SubmodelElement - operationId: PatchSubmodelElementByPath-Metadata_SubmodelRepo # TODO - x-semanticIds: - - https://admin-shell.io/aas/API/PatchSubmodelElementByPath/3/0 - parameters: - #- $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Level' - - name: level - in: query - description: Determines the structural depth of the respective resource content - required: false - schema: - type: string - default: core - enum: - #- deep - - core # only 'core' is allowed for PATCH - requestBody: - description: Metadata attributes of the SubmodelElement - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/SubmodelElementMetadata' - required: true - responses: - '204': - description: SubmodelElement updated successfully - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /submodels/{submodelIdentifier}/submodel-elements/{idShortPath}/$value: - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/SubmodelIdentifier' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/IdShortPath' - get: - tags: - - Submodel Repository API - summary: Returns a specific submodel element from the Submodel at a specified - path in the ValueOnly representation - operationId: GetSubmodelElementByPath-ValueOnly_SubmodelRepo # TODO - x-semanticIds: - - https://admin-shell.io/aas/API/GetSubmodelElementByPath/3/0 - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Level' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Extent' - responses: - '200': - description: Requested submodel element - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/SubmodelElementValue' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - patch: - tags: - - Submodel Repository API - summary: Updates the value of an existing SubmodelElement - operationId: PatchSubmodelElementByPath-ValueOnly_SubmodelRepo # TODO - x-semanticIds: - - https://admin-shell.io/aas/API/PatchSubmodelElementByPath/3/0 - parameters: - #- $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Level' - - name: level - in: query - description: Determines the structural depth of the respective resource content - required: false - schema: - type: string - default: core - enum: - #- deep - - core # only 'core' is allowed for PATCH - requestBody: - description: The SubmodelElement in its ValueOnly representation - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/SubmodelElementValue' - required: true - responses: - '204': - description: Submodel updated successfully - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /submodels/{submodelIdentifier}/submodel-elements/{idShortPath}/$reference: - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/SubmodelIdentifier' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/IdShortPath' - get: - tags: - - Submodel Repository API - summary: Returns the Referene of a specific submodel element from the Submodel at a specified - path - operationId: GetSubmodelElementByPath-Reference_SubmodelRepo # TODO - x-semanticIds: - - https://admin-shell.io/aas/API/GetSubmodelElementByPath/3/0 - parameters: - #- $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Level' - - name: level - in: query - description: Determines the structural depth of the respective resource content - required: false - schema: - type: string - default: core - enum: - # - deep - - core # only 'core' is allowed for Content=Reference - responses: - '200': - description: Requested submodel element - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0#/components/schemas/Reference' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /submodels/{submodelIdentifier}/submodel-elements/{idShortPath}/$path: - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/SubmodelIdentifier' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/IdShortPath' - get: - tags: - - Submodel Repository API - summary: Returns a specific submodel element from the Submodel at a specified - path in the Path notation - operationId: GetSubmodelElementByPath-Path_SubmodelRepo # TODO - x-semanticIds: - - https://admin-shell.io/aas/API/GetSubmodelElementByPath/3/0 - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Level' - responses: - '200': - description: Requested submodel element - content: - application/json: - schema: - type: array - items: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/PathItem' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /submodels/{submodelIdentifier}/submodel-elements/{idShortPath}/attachment: - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/SubmodelIdentifier' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/IdShortPath' - get: - tags: - - Submodel Repository API - summary: Downloads file content from a specific submodel element from the Submodel at a specified path - operationId: GetFileByPath_SubmodelRepo # TODO - x-semanticIds: - - https://admin-shell.io/aas/API/GetFileByPath/3/0 - responses: - '200': - description: Requested file - headers: - Content-Disposition: - schema: - type: string - description: In order to physically download the file usually set to attachment with a filename - example: 'attachment; filename="filename.jpg"' - content: - application/octet-stream: - schema: - type: string - format: binary - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '405': - description: Method not allowed - Download only valid for File submodel element - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/Result' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - put: - tags: - - Submodel Repository API - summary: Uploads file content to an existing submodel element at a specified path within submodel elements hierarchy - operationId: PutFileByPath_SubmodelRepo # TODO - x-semanticIds: - - https://admin-shell.io/aas/API/PutFileByPath/3/0 - requestBody: - description: File to upload - content: - multipart/form-data: - schema: - type: object - properties: - fileName: - type: string - file: - type: string - format: binary - encoding: - file: - contentType: application/octet-stream - required: true - responses: - '204': - description: Submodel element updated successfully - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '405': - description: Method not allowed - Upload only valid for File submodel element - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/Result' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - delete: - tags: - - Submodel Repository API - summary: Deletes file content of an existing submodel element at a specified path within submodel elements hierarchy - operationId: DeleteFileByPath_SubmodelRepo # TODO - x-semanticIds: - - https://admin-shell.io/aas/API/DeleteFileByPath/3/0 - responses: - '200': - description: Submodel element updated successfully - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /submodels/{submodelIdentifier}/submodel-elements/{idShortPath}/invoke: - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/SubmodelIdentifier' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/IdShortPath' - post: - tags: - - Submodel Repository API - summary: Synchronously or asynchronously invokes an Operation at a specified path - operationId: InvokeOperation_SubmodelRepo # TODO - x-semanticIds: - - https://admin-shell.io/aas/API/InvokeOperationSync/3/0 - - https://admin-shell.io/aas/API/InvokeOperationAsync/3/0 - parameters: - - name: async - in: query - description: Determines whether an operation invocation is performed asynchronously or synchronously - schema: - type: boolean - default: false - requestBody: - description: Operation request object - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/OperationRequest' - required: true - responses: - '200': - description: Operation result object - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/OperationResult' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '405': - description: Method not allowed - Invoke only valid for Operation submodel element - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/Result' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /submodels/{submodelIdentifier}/submodel-elements/{idShortPath}/invoke/$value: - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/AssetAdministrationShellIdentifier' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/SubmodelIdentifier' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/IdShortPath' - post: - tags: - - Submodel Repository API - summary: Synchronously or asynchronously invokes an Operation at a specified path - operationId: InvokeOperation-ValueOnly_SubmodelRepo # TODO - x-semanticIds: - - https://admin-shell.io/aas/API/InvokeOperationSync/3/0 - - https://admin-shell.io/aas/API/InvokeOperationAsync/3/0 - parameters: - - name: async - in: query - description: Determines whether an operation invocation is performed asynchronously or synchronously - schema: - type: boolean - default: false - requestBody: - description: Operation request object - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/OperationRequestValueOnly' - required: true - responses: - '200': - description: Operation result object - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/OperationResultValueOnly' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /submodels/{submodelIdentifier}/submodel-elements/{idShortPath}/operation-results/{handleId}: - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/SubmodelIdentifier' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/IdShortPath' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/HandleId' - get: - tags: - - Submodel Repository API - summary: Returns the Operation result of an asynchronous invoked Operation - operationId: GetOperationAsyncResult_SubmodelRepo # TODO - x-semanticIds: - - https://admin-shell.io/aas/API/GetOperationAsyncResult/3/0 - responses: - '200': - description: Operation result object - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/OperationResult' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /submodels/{submodelIdentifier}/submodel-elements/{idShortPath}/operation-results/{handleId}/$value: - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/SubmodelIdentifier' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/IdShortPath' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/HandleId' - get: - tags: - - Submodel Repository API - summary: Returns the Operation result of an asynchronous invoked Operation - operationId: GetOperationAsyncResult-ValueOnly_SubmodelRepo # TODO - x-semanticIds: - - https://admin-shell.io/aas/API/GetOperationAsyncResult/3/0 - responses: - '200': - description: Value of the operation result object - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/OperationResultValueOnly' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - - /concept-descriptions: - get: - tags: - - Concept Description Repository API - summary: Returns all Concept Descriptions - operationId: GetAllConceptDescriptions - x-semanticIds: - - https://admin-shell.io/aas/API/GetAllConceptDescriptions/3/0 - - https://admin-shell.io/aas/API/GetAllConceptDescriptionsByIdShort/3/0 - - https://admin-shell.io/aas/API/GetAllConceptDescriptionsByIsCaseOf/3/0 - - https://admin-shell.io/aas/API/GetAllConceptDescriptionsByDataSpecificationReference/3/0 - parameters: - - name: idShort - in: query - description: The Concept Description’s IdShort - required: false - style: form - explode: true - schema: - type: string - - name: isCaseOf - in: query - description: IsCaseOf reference (UTF8-BASE64-URL-encoded) - required: false - style: form - explode: true - schema: - type: string - format: byte - - name: dataSpecificationRef - in: query - description: DataSpecification reference (UTF8-BASE64-URL-encoded) - required: false - style: form - explode: true - schema: - type: string - format: byte - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Limit' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Cursor' - responses: - '200': - description: Requested Concept Descriptions - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/GetConceptDescriptionsResult' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - post: - tags: - - Concept Description Repository API - summary: Creates a new Concept Description - operationId: PostConceptDescription - x-semanticIds: - - https://admin-shell.io/aas/API/PostConceptDescription/3/0 - requestBody: - description: Concept Description object - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0#/components/schemas/ConceptDescription' - required: true - responses: - '201': - description: Concept Description created successfully - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0#/components/schemas/ConceptDescription' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '409': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/conflict' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /concept-descriptions/{cdIdentifier}: - get: - tags: - - Concept Description Repository API - summary: Returns a specific Concept Description - operationId: GetConceptDescriptionById - x-semanticIds: - - https://admin-shell.io/aas/API/GetConceptDescriptionById/3/0 - parameters: - - name: cdIdentifier - in: path - description: The Concept Description’s unique id (UTF8-BASE64-URL-encoded) - required: true - style: simple - explode: true - schema: - type: string - format: byte - responses: - '200': - description: Requested Concept Description - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0#/components/schemas/ConceptDescription' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - put: - tags: - - Concept Description Repository API - summary: Updates an existing Concept Description - operationId: PutConceptDescriptionById - x-semanticIds: - - https://admin-shell.io/aas/API/PutConceptDescriptionById/3/0 - parameters: - - name: cdIdentifier - in: path - description: The Concept Description’s unique id (UTF8-BASE64-URL-encoded) - required: true - style: simple - explode: false - schema: - type: string - format: byte - requestBody: - description: Concept Description object - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0#/components/schemas/ConceptDescription' - required: true - responses: - '204': - description: Concept Description updated successfully - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - delete: - tags: - - Concept Description Repository API - summary: Deletes a Concept Description - operationId: DeleteConceptDescriptionById - x-semanticIds: - - https://admin-shell.io/aas/API/DeleteConceptDescriptionById/3/0 - parameters: - - name: cdIdentifier - in: path - description: The Concept Description’s unique id (UTF8-BASE64-URL-encoded) - required: true - style: simple - explode: false - schema: - type: string - format: byte - responses: - '204': - description: Concept Description deleted successfully - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /serialization: - get: - tags: - - Serialization API - summary: Returns an appropriate serialization based on the specified format (see SerializationFormat) - operationId: GenerateSerializationByIds - x-semanticIds: - - https://admin-shell.io/aas/API/GenerateSerializationByIds/3/0 - parameters: - - name: aasIds - in: query - description: The Asset Administration Shells' unique ids (UTF8-BASE64-URL-encoded) - style: form - explode: true - schema: - type: array - items: - type: string - - name: submodelIds - in: query - description: The Submodels' unique ids (UTF8-BASE64-URL-encoded) - style: form - explode: true - schema: - type: array - items: - type: string - - name: includeConceptDescriptions - in: query - description: Include Concept Descriptions? - style: form - explode: true - schema: - type: boolean - default: true - responses: - '200': - description: Requested serialization based on SerializationFormat - content: - application/asset-administration-shell-package+xml: - schema: - description: AASX package - type: string - format: binary - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0#/components/schemas/Environment' - application/xml: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0#/components/schemas/Environment' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /description: - get: - tags: - - Description API - summary: Returns the self-describing information of a network resource (ServiceDescription) - operationId: GetDescription - x-semanticIds: - - https://admin-shell.io/aas/API/Descriptor/GetDescription/3/0 - responses: - '200': - description: Requested Description - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/ServiceDescription' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' \ No newline at end of file diff --git a/RepositoryServiceSpecification/V3.0_SSP-001.yaml b/RepositoryServiceSpecification/V3.0_SSP-001.yaml deleted file mode 100644 index 8f151f09..00000000 --- a/RepositoryServiceSpecification/V3.0_SSP-001.yaml +++ /dev/null @@ -1,3424 +0,0 @@ -openapi: 3.0.3 -info: - title: DotAAS Part 2 | HTTP/REST | Repository Service Specification (deprecated) - description: "The entire Repository Service Specification as part of the Specification of the Asset Administration Shell: Part 2. Publisher: Industrial Digital Twin Association (IDTA) 2023" - contact: - name: Industrial Digital Twin Association (IDTA) - email: info@idtwin.org - license: - name: CC BY 4.0 - url: https://creativecommons.org/licenses/by/4.0/ - version: V3.0_SSP-001 - termsOfService: https://github.com/admin-shell-io/aas-specs -servers: -- url: '{protocol}://{host_name}:{port}/api/{version_prefix}' - variables: - protocol: - description: 'Allows access through http and https (recommended)' - enum: - - 'http' - - 'https' - default: 'https' - host_name: - default: admin-shell.io - description: 'Hostname of server hosting the api' - port: - enum: - - '80' - - '443' - default: '443' - description: '80 is default for http, 443 for https' - version_prefix: - enum: - - 'v3.0' - default: v3.0 -paths: - /shells: - get: - tags: - - Asset Administration Shell Repository API - summary: Returns all Asset Administration Shells - operationId: GetAllAssetAdministrationShells - x-semanticIds: - - https://admin-shell.io/aas/API/GetAllAssetAdministrationShells/3/0 - - https://admin-shell.io/aas/API/GetAllAssetAdministrationShellsByAssetId/3/0 - - https://admin-shell.io/aas/API/GetAllAssetAdministrationShellsByIdShort/3/0 - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/AssetIds' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/IdShort' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Limit' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Cursor' - responses: - '200': - description: Requested Asset Administration Shells - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/GetAssetAdministrationShellsResult' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '401': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/unauthorized' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - post: - tags: - - Asset Administration Shell Repository API - summary: Creates a new Asset Administration Shell - operationId: PostAssetAdministrationShell - x-semanticIds: - - https://admin-shell.io/aas/API/PostAssetAdministrationShell/3/0 - requestBody: - description: Asset Administration Shell object - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0#/components/schemas/AssetAdministrationShell' - required: true - responses: - '201': - description: Asset Administration Shell created successfully - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0#/components/schemas/AssetAdministrationShell' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '401': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/unauthorized' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '409': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/conflict' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /shells/$reference: - get: - tags: - - Asset Administration Shell Repository API - summary: Returns References to all Asset Administration Shells - operationId: GetAllAssetAdministrationShells-Reference - x-semanticIds: - - https://admin-shell.io/aas/API/GetAllAssetAdministrationShells/3/0 - - https://admin-shell.io/aas/API/GetAllAssetAdministrationShellsByAssetId/3/0 - - https://admin-shell.io/aas/API/GetAllAssetAdministrationShellsByIdShort/3/0 - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/AssetIds' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/IdShort' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Limit' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Cursor' - responses: - '200': - description: Requested Asset Administration Shells as a list of References - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/GetReferencesResult' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '401': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/unauthorized' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /shells/{aasIdentifier}: - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/AssetAdministrationShellIdentifier' - get: - tags: - - Asset Administration Shell Repository API - summary: Returns a specific Asset Administration Shell - operationId: GetAssetAdministrationShellById - x-semanticIds: - - https://admin-shell.io/aas/API/GetAssetAdministrationShellById/3/0 - responses: - '200': - description: Requested Asset Administration Shell - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0#/components/schemas/AssetAdministrationShell' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '401': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/unauthorized' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - put: - tags: - - Asset Administration Shell Repository API - summary: Updates an existing Asset Administration Shell - operationId: PutAssetAdministrationShellById - x-semanticIds: - - https://admin-shell.io/aas/API/PutAssetAdministrationShellById/3/0 - requestBody: - description: Asset Administration Shell object - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0#/components/schemas/AssetAdministrationShell' - required: true - responses: - '204': - description: Asset Administration Shell updated successfully - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '401': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/unauthorized' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - delete: - tags: - - Asset Administration Shell Repository API - summary: Deletes an Asset Administration Shell - operationId: DeleteAssetAdministrationShellById - x-semanticIds: - - https://admin-shell.io/aas/API/DeleteAssetAdministrationShellById/3/0 - responses: - '204': - description: Asset Administration Shell deleted successfully - '401': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/unauthorized' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - description: Not Found - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/Result' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - description: Default error handling for unmentioned status codes - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/Result' - /shells/{aasIdentifier}/$reference: - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/AssetAdministrationShellIdentifier' - get: - tags: - - Asset Administration Shell Repository API - summary: Returns a specific Asset Administration Shell as a Reference - operationId: GetAssetAdministrationShellById-Reference - x-semanticIds: - - https://admin-shell.io/aas/API/GetAssetAdministrationShellById/3/0 - responses: - '200': - description: Requested Asset Administration Shell - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0#/components/schemas/Reference' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '401': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/unauthorized' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /shells/{aasIdentifier}/asset-information: - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/AssetAdministrationShellIdentifier' - get: - tags: - - Asset Administration Shell Repository API - summary: Returns the Asset Information - operationId: GetAssetInformation - x-semanticIds: - - https://admin-shell.io/aas/API/GetAssetInformation/3/0 - responses: - '200': - description: Requested Asset Information - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0#/components/schemas/AssetInformation' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '401': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/unauthorized' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - put: - tags: - - Asset Administration Shell Repository API - summary: Updates the Asset Information - operationId: PutAssetInformation - x-semanticIds: - - https://admin-shell.io/aas/API/PutAssetInformation/3/0 - requestBody: - description: Asset Information object - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0#/components/schemas/AssetInformation' - required: true - responses: - '204': - description: Asset Information updated successfully - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '401': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/unauthorized' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /shells/{aasIdentifier}/asset-information/thumbnail: - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/AssetAdministrationShellIdentifier' - get: - tags: - - Asset Administration Shell Repository API - operationId: GetThumbnail - x-semanticIds: - - https://admin-shell.io/aas/API/GetThumbnail/3/0 - responses: - '200': - description: The thumbnail of the Asset Information. - content: - application/octet-stream: - schema: - type: string - format: binary - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '401': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/unauthorized' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - put: - tags: - - Asset Administration Shell Repository API - operationId: PutThumbnail - x-semanticIds: - - https://admin-shell.io/aas/API/PutThumbnail/3/0 - requestBody: - description: Thumbnail to upload - content: - multipart/form-data: - schema: - type: object - properties: - fileName: - type: string - file: - type: string - format: binary - encoding: - file: - contentType: application/octet-stream - required: true - responses: - '204': - description: Thumbnail updated successfully - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '401': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/unauthorized' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - delete: - tags: - - Asset Administration Shell Repository API - operationId: DeleteThumbnail - x-semanticIds: - - https://admin-shell.io/aas/API/DeleteThumbnail/3/0 - responses: - '200': - description: Thumbnail deletion successful - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '401': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/unauthorized' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /shells/{aasIdentifier}/submodel-refs: - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/AssetAdministrationShellIdentifier' - get: - tags: - - Asset Administration Shell Repository API - summary: Returns all submodel references - operationId: GetAllSubmodelReferences - x-semanticIds: - - https://admin-shell.io/aas/API/GetAllSubmodelReferences/3/0 - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Limit' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Cursor' - responses: - '200': - description: Requested submodel references - content: - application/json: - schema: - type: array - items: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/GetReferencesResult' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '401': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/unauthorized' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - post: - tags: - - Asset Administration Shell Repository API - summary: Creates a submodel reference at the Asset Administration Shell - operationId: PostSubmodelReference - x-semanticIds: - - https://admin-shell.io/aas/API/PostSubmodelReference/3/0 - requestBody: - description: Reference to the Submodel - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0#/components/schemas/Reference' - required: true - responses: - '201': - description: Submodel reference created successfully - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0#/components/schemas/Reference' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '401': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/unauthorized' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '409': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/conflict' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /shells/{aasIdentifier}/submodel-refs/{submodelIdentifier}: - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/AssetAdministrationShellIdentifier' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/SubmodelIdentifier' - delete: - tags: - - Asset Administration Shell Repository API - summary: Deletes the submodel reference from the Asset Administration Shell. Does not delete the submodel itself! - operationId: DeleteSubmodelReferenceById - x-semanticIds: - - https://admin-shell.io/aas/API/DeleteSubmodelReference/3/0 - responses: - '204': - description: Submodel reference deleted successfully - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '401': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/unauthorized' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /shells/{aasIdentifier}/submodels/{submodelIdentifier}: - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/AssetAdministrationShellIdentifier' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/SubmodelIdentifier' - get: - tags: - - Asset Administration Shell Repository API - summary: Returns the Submodel - operationId: GetSubmodelById_AasRepository - x-semanticIds: - - https://admin-shell.io/aas/API/GetSubmodel/3/0 - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Level' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Extent' - responses: - '200': - description: Requested Submodel - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0#/components/schemas/Submodel' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '401': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/unauthorized' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - put: - tags: - - Asset Administration Shell Repository API - summary: Updates the Submodel - operationId: PutSubmodelById_AasRepository - x-semanticIds: - - https://admin-shell.io/aas/API/PutSubmodel/3/0 - parameters: - #- $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Level' - - name: level - in: query - description: Determines the structural depth of the respective resource content - required: false - schema: - type: string - default: deep - enum: - - deep # only 'deep' is allowed for PUT - #- core - requestBody: - description: Submodel object - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0#/components/schemas/Submodel' - required: true - responses: - '204': - description: Submodel updated successfully - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '401': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/unauthorized' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - patch: - tags: - - Asset Administration Shell Repository API - summary: Updates the Submodel - operationId: PatchSubmodel - x-semanticIds: - - https://admin-shell.io/aas/API/PutSubmodel/3/0 - parameters: - #- $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Level' - - name: level - in: query - description: Determines the structural depth of the respective resource content - required: false - schema: - type: string - default: core - enum: - #- deep - - core # only 'deep' is allowed for PUT - requestBody: - description: Submodel object - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0#/components/schemas/Submodel' - required: true - responses: - '204': - description: Submodel updated successfully - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '401': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/unauthorized' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /shells/{aasIdentifier}/submodels/{submodelIdentifier}/$metadata: - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/AssetAdministrationShellIdentifier' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/SubmodelIdentifier' - delete: - tags: - - Asset Administration Shell Repository API - summary: Deletes the submodel from the Asset Administration Shell and the Repository. - operationId: DeleteSubmodelById_AasRepository - x-semanticIds: - - https://admin-shell.io/aas/API/DeleteSubmodelById/3/0 - responses: - '204': - description: Submodel deleted successfully - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '401': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/unauthorized' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - get: - tags: - - Asset Administration Shell Repository API - summary: Returns the Submodel's metadata elements - operationId: GetSubmodelById-Metadata_AasRepository - x-semanticIds: - - https://admin-shell.io/aas/API/GetSubmodel/3/0 - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Level' - responses: - '200': - description: Requested Submodel - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/SubmodelMetadata' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '401': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/unauthorized' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - patch: - tags: - - Asset Administration Shell Repository API - summary: Updates the metadata attributes of the Submodel - operationId: PatchSubmodelById-Metadata_AasRepository - x-semanticIds: - - https://admin-shell.io/aas/API/PutSubmodel/3/0 - parameters: - #- $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Level' - - name: level - in: query - description: Determines the structural depth of the respective resource content - required: false - schema: - type: string - default: core - enum: - #- deep - - core # only 'deep' is allowed for PUT - requestBody: - description: Submodel object - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/SubmodelMetadata' - required: true - responses: - '204': - description: Submodel updated successfully - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '401': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/unauthorized' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /shells/{aasIdentifier}/submodels/{submodelIdentifier}/$value: - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/AssetAdministrationShellIdentifier' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/SubmodelIdentifier' - get: - tags: - - Asset Administration Shell Repository API - summary: Returns the Submodel's ValueOnly representation - operationId: GetSubmodelById-ValueOnly_AasRepository - x-semanticIds: - - https://admin-shell.io/aas/API/GetSubmodel/3/0 - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Level' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Extent' - responses: - '200': - description: Requested Submodel - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/SubmodelValue' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '401': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/unauthorized' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - patch: - tags: - - Asset Administration Shell Repository API - summary: Updates teh values of the Submodel - operationId: PatchSubmodelById-ValueOnly_AasRepository - x-semanticIds: - - https://admin-shell.io/aas/API/PutSubmodel/3/0 - parameters: - #- $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Level' - - name: level - in: query - description: Determines the structural depth of the respective resource content - required: false - schema: - type: string - default: core - enum: - #- deep - - core # only 'deep' is allowed for PUT - requestBody: - description: Submodel object in the ValueOnly representation - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/SubmodelValue' - required: true - responses: - '204': - description: Submodel updated successfully - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '401': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/unauthorized' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /shells/{aasIdentifier}/submodels/{submodelIdentifier}/$reference: - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/AssetAdministrationShellIdentifier' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/SubmodelIdentifier' - get: - tags: - - Asset Administration Shell Repository API - summary: Returns the Submodel as a Reference - operationId: GetSubmodelById-Reference_AasRepository - x-semanticIds: - - https://admin-shell.io/aas/API/GetSubmodel/3/0 - parameters: - - name: level - in: query - description: Determines the structural depth of the respective resource content - required: false - schema: - type: string - default: core - enum: - # - deep - - core # only 'core' is allowed for Content=Reference - responses: - '200': - description: Requested Submodel as a Reference - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0#/components/schemas/Reference' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '401': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/unauthorized' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - - /shells/{aasIdentifier}/submodels/{submodelIdentifier}/$path: - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/AssetAdministrationShellIdentifier' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/SubmodelIdentifier' - get: - tags: - - Asset Administration Shell Repository API - summary: Returns the Submodel's metadata elements - operationId: GetSubmodelById-Path_AasRepository - x-semanticIds: - - https://admin-shell.io/aas/API/GetSubmodel/3/0 - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Level' - responses: - '200': - description: Requested Submodel in Path notation - content: - application/json: - schema: - type: array - items: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/PathItem' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '401': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/unauthorized' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /shells/{aasIdentifier}/submodels/{submodelIdentifier}/submodel-elements: - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/AssetAdministrationShellIdentifier' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/SubmodelIdentifier' - get: - tags: - - Asset Administration Shell Repository API - summary: Returns all submodel elements including their hierarchy - operationId: GetAllSubmodelElements_AasRepository - x-semanticIds: - - https://admin-shell.io/aas/API/GetAllSubmodelElements/3/0 - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Limit' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Cursor' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Level' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Extent' - responses: - '200': - description: List of found submodel elements - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/GetSubmodelElementsResult' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '401': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/unauthorized' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - post: - tags: - - Asset Administration Shell Repository API - summary: Creates a new submodel element - operationId: PostSubmodelElement - x-semanticIds: - - https://admin-shell.io/aas/API/PostSubmodelElement/3/0 - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Level' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Extent' - requestBody: - description: Requested submodel element - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0#/components/schemas/SubmodelElement' - required: true - responses: - '201': - description: Submodel element created successfully - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0#/components/schemas/SubmodelElement' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '401': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/unauthorized' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '409': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/conflict' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /shells/{aasIdentifier}/submodels/{submodelIdentifier}/submodel-elements/$metadata: - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/AssetAdministrationShellIdentifier' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/SubmodelIdentifier' - get: - tags: - - Asset Administration Shell Repository API - summary: Returns all submodel elements including their hierarchy - operationId: GetAllSubmodelElements-Metadata - x-semanticIds: - - https://admin-shell.io/aas/API/GetAllSubmodelElements/3/0 - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Limit' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Cursor' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Level' - responses: - '200': - description: List of found submodel elements - content: - application/json: - schema: - type: array - items: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/GetSubmodelElementsMetadataResult' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '401': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/unauthorized' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /shells/{aasIdentifier}/submodels/{submodelIdentifier}/submodel-elements/$value: - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/AssetAdministrationShellIdentifier' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/SubmodelIdentifier' - get: - tags: - - Asset Administration Shell Repository API - summary: Returns all submodel elements including their hierarchy in the ValueOnly representation - operationId: GetAllSubmodelElements-ValueOnly - x-semanticIds: - - https://admin-shell.io/aas/API/GetAllSubmodelElements/3/0 - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Limit' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Cursor' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Level' - responses: - '200': - description: List of found submodel elements in their ValueOnly representation - content: - application/json: - schema: - type: array - items: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/GetSubmodelElementsValueResult' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '401': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/unauthorized' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /shells/{aasIdentifier}/submodels/{submodelIdentifier}/submodel-elements/$reference: - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/AssetAdministrationShellIdentifier' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/SubmodelIdentifier' - get: - tags: - - Asset Administration Shell Repository API - summary: Returns all submodel elements as a list of References - operationId: GetAllSubmodelElements-Reference - x-semanticIds: - - https://admin-shell.io/aas/API/GetAllSubmodelElements/3/0 - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Limit' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Cursor' - #- $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Level' - - name: level - in: query - description: Determines the structural depth of the respective resource content - required: false - schema: - type: string - default: core - enum: - # - deep - - core # only 'core' is allowed for Content=Reference - responses: - '200': - description: List of References of the found submodel elements - content: - application/json: - schema: - type: array - items: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/GetReferencesResult' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '401': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/unauthorized' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /shells/{aasIdentifier}/submodels/{submodelIdentifier}/submodel-elements/$path: - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/AssetAdministrationShellIdentifier' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/SubmodelIdentifier' - get: - tags: - - Asset Administration Shell Repository API - summary: Returns all submodel elements including their hierarchy - operationId: GetAllSubmodelElements-Path - x-semanticIds: - - https://admin-shell.io/aas/API/GetAllSubmodelElements/3/0 - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Limit' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Cursor' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Level' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Extent' - responses: - '200': - description: List of found submodel elements in the Path notation - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/GetPathItemsResult' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '401': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/unauthorized' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /shells/{aasIdentifier}/submodels/{submodelIdentifier}/submodel-elements/{idShortPath}: - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/AssetAdministrationShellIdentifier' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/SubmodelIdentifier' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/IdShortPath' - get: - tags: - - Asset Administration Shell Repository API - summary: Returns a specific submodel element from the Submodel at a specified - path - operationId: GetSubmodelElementByPath - x-semanticIds: - - https://admin-shell.io/aas/API/GetSubmodelElementByPath/3/0 - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Limit' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Cursor' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Level' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Extent' - responses: - '200': - description: Requested submodel element - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/GetSubmodelElementsResult' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '401': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/unauthorized' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - post: - tags: - - Asset Administration Shell Repository API - summary: Creates a new submodel element at a specified path within submodel elements hierarchy - operationId: PostSubmodelElementByPath - x-semanticIds: - - https://admin-shell.io/aas/API/PostSubmodelElementByPath/3/0 - requestBody: - description: Requested submodel element - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0#/components/schemas/SubmodelElement' - required: true - responses: - '201': - description: Submodel element created successfully - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0#/components/schemas/SubmodelElement' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '401': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/unauthorized' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '409': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/conflict' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - put: - tags: - - Asset Administration Shell Repository API - summary: Updates an existing submodel element at a specified path within submodel elements hierarchy - operationId: PutSubmodelElementByPath - x-semanticIds: - - https://admin-shell.io/aas/API/PutSubmodelElementByPath/3/0 - - https://admin-shell.io/aas/API/SetSubmodelElementValueByPath/3/0 - requestBody: - description: Requested submodel element - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0#/components/schemas/SubmodelElement' - required: true - responses: - '204': - description: Submodel element updated successfully - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '401': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/unauthorized' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - patch: - tags: - - Asset Administration Shell Repository API - summary: Updates an existing submodel element value at a specified path within submodel elements hierarchy - operationId: PatchSubmodelElementValueByPath - x-semanticIds: - - https://admin-shell.io/aas/API/PatchSubmodelElementByPath/3/0 - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Level' - requestBody: - description: The updated value of the submodel element - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0#/components/schemas/SubmodelElement' - required: true - responses: - '204': - description: Submodel element updated successfully - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '401': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/unauthorized' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - delete: - tags: - - Asset Administration Shell Repository API - summary: Deletes a submodel element at a specified path within the submodel elements hierarchy - operationId: DeleteSubmodelElementByPath - x-semanticIds: - - https://admin-shell.io/aas/API/DeleteSubmodelElementByPath/3/0 - responses: - '204': - description: Submodel element deleted successfully - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '401': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/unauthorized' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /shells/{aasIdentifier}/submodels/{submodelIdentifier}/submodel-elements/{idShortPath}/$metadata: - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/AssetAdministrationShellIdentifier' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/SubmodelIdentifier' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/IdShortPath' - get: - tags: - - Asset Administration Shell Repository API - summary: Returns the metadata attributes if a specific submodel element from the Submodel at a specified - path - operationId: GetSubmodelElementByPath-Metadata - x-semanticIds: - - https://admin-shell.io/aas/API/GetSubmodelElementByPath/3/0 - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Limit' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Cursor' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Level' - responses: - '200': - description: Requested submodel element - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/GetSubmodelElementsMetadataResult' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '401': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/unauthorized' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - patch: - tags: - - Asset Administration Shell Repository API - summary: Updates the metadata attributes of an existing submodel element value at a specified path within submodel elements hierarchy - operationId: PatchSubmodelElementValueByPath-Metadata - x-semanticIds: - - https://admin-shell.io/aas/API/PatchSubmodelElementByPath/3/0 - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Level' - requestBody: - description: The updated metadata attributes of the submodel element - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/SubmodelElementMetadata' - required: true - responses: - '204': - description: Submodel element updated successfully - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '401': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/unauthorized' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /shells/{aasIdentifier}/submodels/{submodelIdentifier}/submodel-elements/{idShortPath}/$value: - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/AssetAdministrationShellIdentifier' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/SubmodelIdentifier' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/IdShortPath' - get: - tags: - - Asset Administration Shell Repository API - summary: Returns a specific submodel element from the Submodel at a specified - path in the ValueOnly representation - operationId: GetSubmodelElementByPath-ValueOnly - x-semanticIds: - - https://admin-shell.io/aas/API/GetSubmodelElementByPath/3/0 - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Limit' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Cursor' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Level' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Extent' - responses: - '200': - description: Requested submodel element in its ValueOnly representation - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/GetSubmodelElementsValueResult' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '401': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/unauthorized' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - patch: - tags: - - Asset Administration Shell Repository API - summary: Updates the value of an existing submodel element value at a specified path within submodel elements hierarchy - operationId: PatchSubmodelElementValueByPath-ValueOnly - x-semanticIds: - - https://admin-shell.io/aas/API/PatchSubmodelElementByPath/3/0 - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Level' - requestBody: - description: The updated value of the submodel element - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/SubmodelElementValue' - required: true - responses: - '204': - description: Submodel element updated successfully - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '401': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/unauthorized' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /shells/{aasIdentifier}/submodels/{submodelIdentifier}/submodel-elements/{idShortPath}/$reference: - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/AssetAdministrationShellIdentifier' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/SubmodelIdentifier' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/IdShortPath' - get: - tags: - - Asset Administration Shell Repository API - summary: Returns the Reference of a specific submodel element from the Submodel at a specified path - operationId: GetSubmodelElementByPath-Reference - x-semanticIds: - - https://admin-shell.io/aas/API/GetSubmodelElementByPath/3/0 - parameters: - #- $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Level' - - name: level - in: query - description: Determines the structural depth of the respective resource content - required: false - schema: - type: string - default: core - enum: - # - deep - - core # only 'core' is allowed for Content=Reference - responses: - '200': - description: Requested submodel element in its ValueOnly representation - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0#/components/schemas/Reference' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '401': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/unauthorized' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /shells/{aasIdentifier}/submodels/{submodelIdentifier}/submodel-elements/{idShortPath}/$path: - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/AssetAdministrationShellIdentifier' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/SubmodelIdentifier' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/IdShortPath' - get: - tags: - - Asset Administration Shell Repository API - summary: Returns a specific submodel element from the Submodel at a specified path in the Path notation - operationId: GetSubmodelElementByPath-Path - x-semanticIds: - - https://admin-shell.io/aas/API/GetSubmodelElementByPath/3/0 - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Level' - responses: - '200': - description: Requested submodel element in the Path notation - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/PathItem' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '401': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/unauthorized' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /shells/{aasIdentifier}/submodels/{submodelIdentifier}/submodel-elements/{idShortPath}/attachment: - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/AssetAdministrationShellIdentifier' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/SubmodelIdentifier' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/IdShortPath' - get: - tags: - - Asset Administration Shell Repository API - summary: Downloads file content from a specific submodel element from the Submodel at a specified path - operationId: GetFileByPath - x-semanticIds: - - https://admin-shell.io/aas/API/GetFileByPath/3/0 - responses: - '200': - description: Requested file - headers: - Content-Disposition: - schema: - type: string - description: In order to physically download the file usually set to attachment with a filename - example: 'attachment; filename="filename.jpg"' - content: - application/octet-stream: - schema: - type: string - format: binary - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '401': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/unauthorized' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - put: - tags: - - Asset Administration Shell Repository API - summary: Uploads file content to an existing submodel element at a specified path within submodel elements hierarchy - operationId: PutFileByPath - x-semanticIds: - - https://admin-shell.io/aas/API/PutFileByPath/3/0 - requestBody: - description: File to upload - content: - multipart/form-data: - schema: - type: object - properties: - fileName: - type: string - file: - type: string - format: binary - encoding: - file: - contentType: application/octet-stream - required: true - responses: - '204': - description: Submodel element updated successfully - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '401': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/unauthorized' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - delete: - tags: - - Asset Administration Shell Repository API - summary: Deletes file content of an existing submodel element at a specified path within submodel elements hierarchy - operationId: DeleteFileByPath - x-semanticIds: - - https://admin-shell.io/aas/API/DeleteFileByPath/3/0 - responses: - '200': - description: Submodel element updated successfully - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '401': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/unauthorized' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /shells/{aasIdentifier}/submodels/{submodelIdentifier}/submodel-elements/{idShortPath}/invoke: - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/AssetAdministrationShellIdentifier' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/SubmodelIdentifier' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/IdShortPath' - post: - tags: - - Asset Administration Shell Repository API - summary: Synchronously invokes an Operation at a specified path - operationId: InvokeOperation - x-semanticIds: - - https://admin-shell.io/aas/API/InvokeOperationSync/3/0 - requestBody: - description: Operation request object - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/OperationRequest' - required: true - responses: - '200': - description: Operation result object - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/OperationResult' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '401': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/unauthorized' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /shells/{aasIdentifier}/submodels/{submodelIdentifier}/submodel-elements/{idShortPath}/invoke/$value: - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/AssetAdministrationShellIdentifier' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/SubmodelIdentifier' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/IdShortPath' - post: - tags: - - Asset Administration Shell Repository API - summary: Synchronously invokes an Operation at a specified path - operationId: InvokeOperation-ValueOnly - x-semanticIds: - - https://admin-shell.io/aas/API/InvokeOperationSync/3/0 - requestBody: - description: Operation request object - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/OperationRequestValueOnly' - required: true - responses: - '200': - description: Operation result object - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/OperationResultValueOnly' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '401': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/unauthorized' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /shells/{aasIdentifier}/submodels/{submodelIdentifier}/submodel-elements/{idShortPath}/invoke-async: - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/AssetAdministrationShellIdentifier' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/SubmodelIdentifier' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/IdShortPath' - post: - tags: - - Asset Administration Shell Repository API - summary: Asynchronously invokes an Operation at a specified path - operationId: InvokeOperationAsync - x-semanticIds: - - https://admin-shell.io/aas/API/InvokeOperationAsync/3/0 - requestBody: - description: Operation request object - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/OperationRequest' - required: true - responses: - '202': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/accepted' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '401': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/unauthorized' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /shells/{aasIdentifier}/submodels/{submodelIdentifier}/submodel-elements/{idShortPath}/invoke-async/$value: - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/AssetAdministrationShellIdentifier' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/SubmodelIdentifier' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/IdShortPath' - post: - tags: - - Asset Administration Shell Repository API - summary: Asynchronously invokes an Operation at a specified path - operationId: InvokeOperationAsync-ValueOnly - x-semanticIds: - - https://admin-shell.io/aas/API/InvokeOperationAsync/3/0 - requestBody: - description: Operation request object - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/OperationRequestValueOnly' - required: true - responses: - '202': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/accepted' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '401': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/unauthorized' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /shells/{aasIdentifier}/submodels/{submodelIdentifier}/submodel-elements/{idShortPath}/operation-status/{handleId}: - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/AssetAdministrationShellIdentifier' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/SubmodelIdentifier' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/IdShortPath' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/HandleId' - get: - tags: - - Asset Administration Shell Repository API - summary: Returns the status of an asynchronously invoked Operation - operationId: GetOperationAsyncStatus - x-semanticIds: - - https://admin-shell.io/aas/API/GetOperationAsyncStatus/3/0 - responses: - '200': - description: Operation result object containing information that the 'executionState' is still 'Running' - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/BaseOperationResult' - '302': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/found' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '401': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/unauthorized' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /shells/{aasIdentifier}/submodels/{submodelIdentifier}/submodel-elements/{idShortPath}/operation-results/{handleId}: - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/AssetAdministrationShellIdentifier' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/SubmodelIdentifier' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/IdShortPath' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/HandleId' - get: - tags: - - Asset Administration Shell Repository API - summary: Returns the Operation result of an asynchronous invoked Operation - operationId: GetOperationAsyncResult - x-semanticIds: - - https://admin-shell.io/aas/API/GetOperationAsyncResult/3/0 - responses: - '200': - description: Operation result object - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/OperationResult' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '401': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/unauthorized' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /shells/{aasIdentifier}/submodels/{submodelIdentifier}/submodel-elements/{idShortPath}/operation-results/{handleId}/$value: - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/AssetAdministrationShellIdentifier' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/SubmodelIdentifier' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/IdShortPath' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/HandleId' - get: - tags: - - Asset Administration Shell Repository API - summary: Returns the ValueOnly notation of the Operation result of an asynchronous invoked Operation - operationId: GetOperationAsyncResult-ValueOnly - x-semanticIds: - - https://admin-shell.io/aas/API/GetOperationAsyncResult/3/0 - responses: - '200': - description: Operation result object - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/OperationResultValueOnly' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '401': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/unauthorized' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - - /submodels: - get: - tags: - - Submodel Repository API - summary: Returns all Submodels - operationId: GetAllSubmodels - x-semanticIds: - - https://admin-shell.io/aas/API/GetAllSubmodels/3/0 - - https://admin-shell.io/aas/API/GetAllSubmodelsBySemanticId/3/0 - - https://admin-shell.io/aas/API/GetAllSubmodelsByIdShort/3/0 - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/SemanticId' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/IdShort' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Limit' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Cursor' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Level' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Extent' - responses: - '200': - description: Requested Submodels - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/GetSubmodelsResult' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '401': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/unauthorized' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - post: - tags: - - Submodel Repository API - summary: Creates a new Submodel - operationId: PostSubmodel - x-semanticIds: - - https://admin-shell.io/aas/API/PostSubmodel/3/0 - requestBody: - description: Submodel object - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0#/components/schemas/Submodel' - required: true - responses: - '201': - description: Submodel created successfully - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0#/components/schemas/Submodel' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '401': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/unauthorized' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '409': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/conflict' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /submodels/$metadata: - get: - tags: - - Submodel Repository API - summary: Returns the metadata attributes of all Submodels - operationId: GetAllSubmodels-Metadata - x-semanticIds: - - https://admin-shell.io/aas/API/GetAllSubmodels/3/0 - - https://admin-shell.io/aas/API/GetAllSubmodelsBySemanticId/3/0 - - https://admin-shell.io/aas/API/GetAllSubmodelsByIdShort/3/0 - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/SemanticId' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/IdShort' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Limit' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Cursor' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Level' - responses: - '200': - description: Requested Submodels - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/GetSubmodelsMetadataResult' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '401': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/unauthorized' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /submodels/$value: - get: - tags: - - Submodel Repository API - summary: Returns all Submodels in their ValueOnly representation - operationId: GetAllSubmodels-ValueOnly - x-semanticIds: - - https://admin-shell.io/aas/API/GetAllSubmodels/3/0 - - https://admin-shell.io/aas/API/GetAllSubmodelsBySemanticId/3/0 - - https://admin-shell.io/aas/API/GetAllSubmodelsByIdShort/3/0 - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/SemanticId' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/IdShort' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Limit' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Cursor' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Level' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Extent' - responses: - '200': - description: Requested Submodels - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/GetSubmodelsValueResult' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '401': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/unauthorized' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /submodels/$reference: - get: - tags: - - Submodel Repository API - summary: Returns the References for all Submodels - operationId: GetAllSubmodels-Reference - x-semanticIds: - - https://admin-shell.io/aas/API/GetAllSubmodels/3/0 - - https://admin-shell.io/aas/API/GetAllSubmodelsBySemanticId/3/0 - - https://admin-shell.io/aas/API/GetAllSubmodelsByIdShort/3/0 - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/SemanticId' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/IdShort' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Limit' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Cursor' - #- $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Level' - - name: level - in: query - description: Determines the structural depth of the respective resource content - required: false - schema: - type: string - default: core - enum: - # - deep - - core # only 'core' is allowed for Content=Reference - responses: - '200': - description: References of the requested Submodels - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/GetReferencesResult' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '401': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/unauthorized' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /submodels/$path: - get: - tags: - - Submodel Repository API - summary: Returns all Submodels in the Path notation - operationId: GetAllSubmodels-Path - x-semanticIds: - - https://admin-shell.io/aas/API/GetAllSubmodels/3/0 - - https://admin-shell.io/aas/API/GetAllSubmodelsBySemanticId/3/0 - - https://admin-shell.io/aas/API/GetAllSubmodelsByIdShort/3/0 - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/SemanticId' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/IdShort' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Limit' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Cursor' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Level' - responses: - '200': - description: Requested Submodels - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/GetPathItemsResult' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '401': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/unauthorized' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /submodels/{submodelIdentifier}: - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/SubmodelIdentifier' - get: - tags: - - Submodel Repository API - summary: Returns a specific Submodel - operationId: GetSubmodelById - x-semanticIds: - - https://admin-shell.io/aas/API/GetSubmodelById/3/0 - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Level' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Extent' - responses: - '200': - description: Requested Submodel - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0#/components/schemas/Submodel' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '401': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/unauthorized' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - put: - tags: - - Submodel Repository API - summary: Updates an existing Submodel - operationId: PutSubmodelById - x-semanticIds: - - https://admin-shell.io/aas/API/PutSubmodelById/3/0 - parameters: - #- $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Level' - - name: level - in: query - description: Determines the structural depth of the respective resource content - required: false - schema: - type: string - default: deep - enum: - - deep # only 'deep' is allowed for PUT - #- core - requestBody: - description: Submodel object - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0#/components/schemas/Submodel' - required: true - responses: - '204': - description: Submodel updated successfully - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '401': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/unauthorized' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - patch: - tags: - - Submodel Repository API - summary: Updates an existing Submodel - operationId: PatchSubmodelById - x-semanticIds: - - https://admin-shell.io/aas/API/PatchSubmodelById/3/0 - parameters: - #- $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Level' - - name: level - in: query - description: Determines the structural depth of the respective resource content - required: false - schema: - type: string - default: core - enum: - #- deep - - core # only 'core' is allowed for PATCH - requestBody: - description: Submodel object - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0#/components/schemas/Submodel' - required: true - responses: - '204': - description: Submodel updated successfully - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '401': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/unauthorized' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - delete: - tags: - - Submodel Repository API - summary: Deletes a Submodel - operationId: DeleteSubmodelById - x-semanticIds: - - https://admin-shell.io/aas/API/DeleteSubmodelById/3/0 - responses: - '204': - description: Submodel deleted successfully - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '401': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/unauthorized' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /submodels/{submodelIdentifier}/$metadata: - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/SubmodelIdentifier' - get: - tags: - - Submodel Repository API - summary: Returns the metadata attributes of a specific Submodel - operationId: GetSubmodelById-Metadata - x-semanticIds: - - https://admin-shell.io/aas/API/GetSubmodelById/3/0 - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Level' - responses: - '200': - description: Requested Submodel in the metadata representation - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/SubmodelMetadata' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '401': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/unauthorized' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - patch: - tags: - - Submodel Repository API - summary: Updates the metadata attributes of an existing Submodel - operationId: PatchSubmodelById-Metadata - x-semanticIds: - - https://admin-shell.io/aas/API/PatchSubmodelById/3/0 - parameters: - #- $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Level' - - name: level - in: query - description: Determines the structural depth of the respective resource content - required: false - schema: - type: string - default: core - enum: - #- deep - - core # only 'core' is allowed for PATCH - requestBody: - description: The metadata attributes of the Submodel object - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/SubmodelMetadata' - required: true - responses: - '204': - description: Submodel updated successfully - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '401': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/unauthorized' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /submodels/{submodelIdentifier}/$value: - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/SubmodelIdentifier' - get: - tags: - - Submodel Repository API - summary: Returns a specific Submodel in the ValueOnly representation - operationId: GetSubmodelById-ValueOnly - x-semanticIds: - - https://admin-shell.io/aas/API/GetSubmodelById/3/0 - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Level' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Extent' - responses: - '200': - description: Requested Submodel - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/SubmodelValue' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '401': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/unauthorized' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - patch: - tags: - - Submodel Repository API - summary: Updates the values of an existing Submodel - operationId: PatchSubmodelById-ValueOnly - x-semanticIds: - - https://admin-shell.io/aas/API/PatchSubmodelById/3/0 - parameters: - #- $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Level' - - name: level - in: query - description: Determines the structural depth of the respective resource content - required: false - schema: - type: string - default: core - enum: - #- deep - - core # only 'core' is allowed for PATCH - requestBody: - description: Submodel object in its ValueOnly representation - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/SubmodelValue' - required: true - responses: - '204': - description: Submodel updated successfully - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '401': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/unauthorized' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /submodels/{submodelIdentifier}/$reference: - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/SubmodelIdentifier' - get: - tags: - - Submodel Repository API - summary: Returns the Reference of a specific Submodel - operationId: GetSubmodelById-Reference - x-semanticIds: - - https://admin-shell.io/aas/API/GetSubmodelById/3/0 - parameters: - #- $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Level' - - name: level - in: query - description: Determines the structural depth of the respective resource content - required: false - schema: - type: string - default: core - enum: - # - deep - - core # only 'core' is allowed for Content=Reference - responses: - '200': - description: Requested Submodel - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0#/components/schemas/Reference' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '401': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/unauthorized' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /submodels/{submodelIdentifier}/$path: - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/SubmodelIdentifier' - get: - tags: - - Submodel Repository API - summary: Returns a specific Submodel in the Path notation - operationId: GetSubmodelById-Path - x-semanticIds: - - https://admin-shell.io/aas/API/GetSubmodelById/3/0 - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Level' - responses: - '200': - description: Requested Submodel - content: - application/json: - schema: - type: array - items: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/PathItem' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '401': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/unauthorized' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /submodels/{submodelIdentifier}/submodel-elements: - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/SubmodelIdentifier' - get: - tags: - - Submodel Repository API - summary: Returns all submodel elements including their hierarchy - operationId: GetAllSubmodelElements - x-semanticIds: - - https://admin-shell.io/aas/API/GetAllSubmodelElements/3/0 - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Limit' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Cursor' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Level' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Extent' - responses: - '200': - description: List of found submodel elements - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/GetSubmodelElementsResult' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '401': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/unauthorized' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - description: Default error handling for unmentioned status codes - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/Result' - post: - tags: - - Submodel Repository API - summary: Creates a new submodel element - operationId: PostSubmodelElement_SubmodelRepo - x-semanticIds: - - https://admin-shell.io/aas/API/PostSubmodelElement/3/0 - requestBody: - description: Requested submodel element - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0#/components/schemas/SubmodelElement' - required: true - responses: - '201': - description: Submodel element created successfully - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0#/components/schemas/SubmodelElement' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '401': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/unauthorized' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '409': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/conflict' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /submodels/{submodelIdentifier}/submodel-elements/$metadata: - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/SubmodelIdentifier' - get: - tags: - - Submodel Repository API - summary: Returns the metadata attributes of all submodel elements including their hierarchy - operationId: GetAllSubmodelElements-Metadata_SubmodelRepo - x-semanticIds: - - https://admin-shell.io/aas/API/GetAllSubmodelElements/3/0 - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Limit' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Cursor' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Level' - responses: - '200': - description: List of found submodel elements - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/GetSubmodelElementsMetadataResult' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '401': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/unauthorized' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /submodels/{submodelIdentifier}/submodel-elements/$value: - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/SubmodelIdentifier' - get: - tags: - - Submodel Repository API - summary: Returns all submodel elements including their hierarchy in the ValueOnly representation - operationId: GetAllSubmodelElements-ValueOnly_SubmodelRepo - x-semanticIds: - - https://admin-shell.io/aas/API/GetAllSubmodelElements/3/0 - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Limit' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Cursor' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Level' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Extent' - responses: - '200': - description: List of found submodel elements - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/GetSubmodelElementsValueResult' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '401': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/unauthorized' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /submodels/{submodelIdentifier}/submodel-elements/$reference: - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/SubmodelIdentifier' - get: - tags: - - Submodel Repository API - summary: Returns the References of all submodel elements - operationId: GetAllSubmodelElements-Reference_SubmodelRepo - x-semanticIds: - - https://admin-shell.io/aas/API/GetAllSubmodelElements/3/0 - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Limit' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Cursor' - #- $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Level' - - name: level - in: query - description: Determines the structural depth of the respective resource content - required: false - schema: - type: string - default: core - enum: - # - deep - - core # only 'core' is allowed for Content=Reference - responses: - '200': - description: List of found submodel elements - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/GetReferencesResult' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '401': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/unauthorized' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /submodels/{submodelIdentifier}/submodel-elements/$path: - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/SubmodelIdentifier' - get: - tags: - - Submodel Repository API - summary: Returns all submodel elements including their hierarchy in the Path notation - operationId: GetAllSubmodelElements-Path_SubmodelRepo - x-semanticIds: - - https://admin-shell.io/aas/API/GetAllSubmodelElements/3/0 - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Limit' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Cursor' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Level' - responses: - '200': - description: List of found submodel elements in the Path notation - content: - application/json: - schema: - type: array - items: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/GetPathItemsResult' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '401': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/unauthorized' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /submodels/{submodelIdentifier}/submodel-elements/{idShortPath}: - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/SubmodelIdentifier' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/IdShortPath' - get: - tags: - - Submodel Repository API - summary: Returns a specific submodel element from the Submodel at a specified - path - operationId: GetSubmodelElementByPath_SubmodelRepo - x-semanticIds: - - https://admin-shell.io/aas/API/GetSubmodelElementByPath/3/0 - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Level' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Extent' - responses: - '200': - description: Requested submodel element - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0#/components/schemas/SubmodelElement' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '401': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/unauthorized' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - post: - tags: - - Submodel Repository API - summary: Creates a new submodel element at a specified path within submodel elements hierarchy - operationId: PostSubmodelElementByPath_SubmodelRepo - x-semanticIds: - - https://admin-shell.io/aas/API/PostSubmodelElementByPath/3/0 - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Level' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Extent' - requestBody: - description: Requested submodel element - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0#/components/schemas/SubmodelElement' - required: true - responses: - '201': - description: Submodel element created successfully - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0#/components/schemas/SubmodelElement' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '401': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/unauthorized' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '409': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/conflict' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - put: - tags: - - Submodel Repository API - summary: Updates an existing submodel element at a specified path within submodel elements hierarchy - operationId: PutSubmodelElementByPath_SubmodelRepo - x-semanticIds: - - https://admin-shell.io/aas/API/PutSubmodelElementByPath/3/0 - - https://admin-shell.io/aas/API/SetSubmodelElementValueByPath/3/0 - parameters: - #- $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Level' - - name: level - in: query - description: Determines the structural depth of the respective resource content - required: false - schema: - type: string - default: deep - enum: - - deep # only 'deep' is allowed for PUT - #- core - requestBody: - description: Requested submodel element - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0#/components/schemas/SubmodelElement' - required: true - responses: - '204': - description: Submodel element updated successfully - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '401': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/unauthorized' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - patch: - tags: - - Submodel Repository API - summary: Updates an existing SubmodelElement - operationId: PatchSubmodelElementByPath_SubmodelRepo - x-semanticIds: - - https://admin-shell.io/aas/API/PatchSubmodelById/3/0 - parameters: - #- $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Level' - - name: level - in: query - description: Determines the structural depth of the respective resource content - required: false - schema: - type: string - default: core - enum: - #- deep - - core # only 'core' is allowed for PATCH - requestBody: - description: SubmodelElement object - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0#/components/schemas/SubmodelElement' - required: true - responses: - '204': - description: SubmodelElement updated successfully - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '401': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/unauthorized' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - delete: - tags: - - Submodel Repository API - summary: Deletes a submodel element at a specified path within the submodel elements hierarchy - operationId: DeleteSubmodelElementByPath_SubmodelRepo - x-semanticIds: - - https://admin-shell.io/aas/API/DeleteSubmodelElementByPath/3/0 - responses: - '204': - description: Submodel element deleted successfully - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '401': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/unauthorized' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /submodels/{submodelIdentifier}/submodel-elements/{idShortPath}/$metadata: - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/SubmodelIdentifier' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/IdShortPath' - get: - tags: - - Submodel Repository API - summary: Returns the matadata attributes of a specific submodel element from the Submodel at a specified - path - operationId: GetSubmodelElementByPath-Metadata_SubmodelRepo - x-semanticIds: - - https://admin-shell.io/aas/API/GetSubmodelElementByPath/3/0 - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Level' - responses: - '200': - description: Metadata attributes of the requested submodel element - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/SubmodelElementMetadata' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '401': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/unauthorized' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - patch: - tags: - - Submodel Repository API - summary: Updates the metadata attributes an existing SubmodelElement - operationId: PatchSubmodelElementByPath-Metadata_SubmodelRepo - x-semanticIds: - - https://admin-shell.io/aas/API/PatchSubmodelElementByPath/3/0 - parameters: - #- $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Level' - - name: level - in: query - description: Determines the structural depth of the respective resource content - required: false - schema: - type: string - default: core - enum: - #- deep - - core # only 'core' is allowed for PATCH - requestBody: - description: Metadata attributes of the SubmodelElement - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/SubmodelElementMetadata' - required: true - responses: - '204': - description: SubmodelElement updated successfully - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '401': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/unauthorized' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /submodels/{submodelIdentifier}/submodel-elements/{idShortPath}/$value: - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/SubmodelIdentifier' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/IdShortPath' - get: - tags: - - Submodel Repository API - summary: Returns a specific submodel element from the Submodel at a specified - path in the ValueOnly representation - operationId: GetSubmodelElementByPath-ValueOnly_SubmodelRepo - x-semanticIds: - - https://admin-shell.io/aas/API/GetSubmodelElementByPath/3/0 - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Level' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Extent' - responses: - '200': - description: Requested submodel element - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/SubmodelElementValue' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '401': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/unauthorized' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - patch: - tags: - - Submodel Repository API - summary: Updates the value of an existing SubmodelElement - operationId: PatchSubmodelElementByPath-ValueOnly_SubmodelRepo - x-semanticIds: - - https://admin-shell.io/aas/API/PatchSubmodelElementByPath/3/0 - parameters: - #- $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Level' - - name: level - in: query - description: Determines the structural depth of the respective resource content - required: false - schema: - type: string - default: core - enum: - #- deep - - core # only 'core' is allowed for PATCH - requestBody: - description: The SubmodelElement in its ValueOnly representation - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/SubmodelElementValue' - required: true - responses: - '204': - description: Submodel updated successfully - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '401': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/unauthorized' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /submodels/{submodelIdentifier}/submodel-elements/{idShortPath}/$reference: - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/SubmodelIdentifier' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/IdShortPath' - get: - tags: - - Submodel Repository API - summary: Returns the Referene of a specific submodel element from the Submodel at a specified - path - operationId: GetSubmodelElementByPath-Reference_SubmodelRepo - x-semanticIds: - - https://admin-shell.io/aas/API/GetSubmodelElementByPath/3/0 - parameters: - #- $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Level' - - name: level - in: query - description: Determines the structural depth of the respective resource content - required: false - schema: - type: string - default: core - enum: - # - deep - - core # only 'core' is allowed for Content=Reference - responses: - '200': - description: Requested submodel element - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0#/components/schemas/Reference' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '401': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/unauthorized' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /submodels/{submodelIdentifier}/submodel-elements/{idShortPath}/$path: - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/SubmodelIdentifier' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/IdShortPath' - get: - tags: - - Submodel Repository API - summary: Returns a specific submodel element from the Submodel at a specified - path in the Path notation - operationId: GetSubmodelElementByPath-Path_SubmodelRepo - x-semanticIds: - - https://admin-shell.io/aas/API/GetSubmodelElementByPath/3/0 - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Level' - responses: - '200': - description: Requested submodel element - content: - application/json: - schema: - type: array - items: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/PathItem' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '401': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/unauthorized' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /submodels/{submodelIdentifier}/submodel-elements/{idShortPath}/attachment: - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/SubmodelIdentifier' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/IdShortPath' - get: - tags: - - Submodel Repository API - summary: Downloads file content from a specific submodel element from the Submodel at a specified path - operationId: GetFileByPath_SubmodelRepo - x-semanticIds: - - https://admin-shell.io/aas/API/GetFileByPath/3/0 - responses: - '200': - description: Requested file - headers: - Content-Disposition: - schema: - type: string - description: In order to physically download the file usually set to attachment with a filename - example: 'attachment; filename="filename.jpg"' - content: - application/octet-stream: - schema: - type: string - format: binary - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '401': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/unauthorized' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '405': - description: Method not allowed - Download only valid for File submodel element - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/Result' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - put: - tags: - - Submodel Repository API - summary: Uploads file content to an existing submodel element at a specified path within submodel elements hierarchy - operationId: PutFileByPath_SubmodelRepo - x-semanticIds: - - https://admin-shell.io/aas/API/PutFileByPath/3/0 - requestBody: - description: File to upload - content: - multipart/form-data: - schema: - type: object - properties: - fileName: - type: string - file: - type: string - format: binary - encoding: - file: - contentType: application/octet-stream - required: true - responses: - '204': - description: Submodel element updated successfully - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '401': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/unauthorized' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '405': - description: Method not allowed - Upload only valid for File submodel element - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/Result' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - delete: - tags: - - Submodel Repository API - summary: Deletes file content of an existing submodel element at a specified path within submodel elements hierarchy - operationId: DeleteFileByPath_SubmodelRepo - x-semanticIds: - - https://admin-shell.io/aas/API/DeleteFileByPath/3/0 - responses: - '200': - description: Submodel element updated successfully - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '401': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/unauthorized' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /submodels/{submodelIdentifier}/submodel-elements/{idShortPath}/invoke: - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/SubmodelIdentifier' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/IdShortPath' - post: - tags: - - Submodel Repository API - summary: Synchronously or asynchronously invokes an Operation at a specified path - operationId: InvokeOperation_SubmodelRepo - x-semanticIds: - - https://admin-shell.io/aas/API/InvokeOperationSync/3/0 - - https://admin-shell.io/aas/API/InvokeOperationAsync/3/0 - parameters: - - name: async - in: query - description: Determines whether an operation invocation is performed asynchronously or synchronously - schema: - type: boolean - default: false - requestBody: - description: Operation request object - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/OperationRequest' - required: true - responses: - '200': - description: Operation result object - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/OperationResult' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '401': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/unauthorized' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '405': - description: Method not allowed - Invoke only valid for Operation submodel element - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/Result' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /submodels/{submodelIdentifier}/submodel-elements/{idShortPath}/invoke/$value: - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/AssetAdministrationShellIdentifier' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/SubmodelIdentifier' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/IdShortPath' - post: - tags: - - Submodel Repository API - summary: Synchronously or asynchronously invokes an Operation at a specified path - operationId: InvokeOperation-ValueOnly_SubmodelRepo - x-semanticIds: - - https://admin-shell.io/aas/API/InvokeOperationSync/3/0 - - https://admin-shell.io/aas/API/InvokeOperationAsync/3/0 - parameters: - - name: async - in: query - description: Determines whether an operation invocation is performed asynchronously or synchronously - schema: - type: boolean - default: false - requestBody: - description: Operation request object - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/OperationRequestValueOnly' - required: true - responses: - '200': - description: Operation result object - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/OperationResultValueOnly' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '401': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/unauthorized' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - - /submodels/{submodelIdentifier}/submodel-elements/{idShortPath}/invoke-async: - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/SubmodelIdentifier' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/IdShortPath' - post: - tags: - - Submodel Repository API - summary: Asynchronously invokes an Operation at a specified path - operationId: InvokeOperationAsync_SubmodelRepo - x-semanticIds: - - https://admin-shell.io/aas/API/InvokeOperationAsync/3/0 - requestBody: - description: Operation request object - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/OperationRequest' - required: true - responses: - '202': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/accepted' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '401': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/unauthorized' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '405': - description: Method not allowed - Invoke only valid for Operation submodel element - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/Result' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /submodels/{submodelIdentifier}/submodel-elements/{idShortPath}/invoke-async/$value: - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/AssetAdministrationShellIdentifier' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/SubmodelIdentifier' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/IdShortPath' - post: - tags: - - Submodel Repository API - summary: Asynchronously invokes an Operation at a specified path - operationId: InvokeOperationAsync-ValueOnly_SubmodelRepo - x-semanticIds: - - https://admin-shell.io/aas/API/InvokeOperationAsync/3/0 - requestBody: - description: Operation request object - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/OperationRequestValueOnly' - required: true - responses: - '202': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/accepted' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '401': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/unauthorized' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /submodels/{submodelIdentifier}/submodel-elements/{idShortPath}/operation-status/{handleId}: - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/SubmodelIdentifier' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/IdShortPath' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/HandleId' - get: - tags: - - Submodel Repository API - summary: Returns the status of an asynchronously invoked Operation - operationId: GetOperationAsyncStatus_SubmodelRepo - x-semanticIds: - - https://admin-shell.io/aas/API/GetOperationAsyncStatus/3/0 - responses: - '200': - description: Operation result object containing information that the 'executionState' is still 'Running' - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/BaseOperationResult' - '302': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/found' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '401': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/unauthorized' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /submodels/{submodelIdentifier}/submodel-elements/{idShortPath}/operation-results/{handleId}: - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/SubmodelIdentifier' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/IdShortPath' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/HandleId' - get: - tags: - - Submodel Repository API - summary: Returns the Operation result of an asynchronous invoked Operation - operationId: GetOperationAsyncResult_SubmodelRepo - x-semanticIds: - - https://admin-shell.io/aas/API/GetOperationAsyncResult/3/0 - responses: - '200': - description: Operation result object - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/OperationResult' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '401': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/unauthorized' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /submodels/{submodelIdentifier}/submodel-elements/{idShortPath}/operation-results/{handleId}/$value: - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/SubmodelIdentifier' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/IdShortPath' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/HandleId' - get: - tags: - - Submodel Repository API - summary: Returns the Operation result of an asynchronous invoked Operation - operationId: GetOperationAsyncResult-ValueOnly_SubmodelRepo - x-semanticIds: - - https://admin-shell.io/aas/API/GetOperationAsyncResult/3/0 - responses: - '200': - description: Value of the operation result object - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/OperationResultValueOnly' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '401': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/unauthorized' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - - /serialization: - get: - tags: - - Serialization API - summary: Returns an appropriate serialization based on the specified format (see SerializationFormat) - operationId: GenerateSerializationByIds - x-semanticIds: - - https://admin-shell.io/aas/API/GenerateSerializationByIds/3/0 - parameters: - - name: aasIds - in: query - description: The Asset Administration Shells' unique ids (UTF8-BASE64-URL-encoded) - style: form - explode: true - schema: - type: array - items: - type: string - - name: submodelIds - in: query - description: The Submodels' unique ids (UTF8-BASE64-URL-encoded) - style: form - explode: true - schema: - type: array - items: - type: string - - name: includeConceptDescriptions - in: query - description: Include Concept Descriptions? - style: form - explode: true - schema: - type: boolean - default: true - responses: - '200': - description: Requested serialization based on SerializationFormat - content: - application/asset-administration-shell-package+xml: - schema: - description: AASX package - type: string - format: binary - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0#/components/schemas/Environment' - application/xml: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0#/components/schemas/Environment' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '401': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/unauthorized' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /description: - get: - tags: - - Description API - summary: Returns the self-describing information of a network resource (ServiceDescription) - operationId: GetDescription - x-semanticIds: - - https://admin-shell.io/aas/API/Descriptor/GetDescription/3/0 - responses: - '200': - description: Requested Description - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/ServiceDescription' - '401': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/unauthorized' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' \ No newline at end of file diff --git a/RepositoryServiceSpecification/V3.0_SSP-002.yaml b/RepositoryServiceSpecification/V3.0_SSP-002.yaml deleted file mode 100644 index eb4d9ec7..00000000 --- a/RepositoryServiceSpecification/V3.0_SSP-002.yaml +++ /dev/null @@ -1,1663 +0,0 @@ -openapi: 3.0.3 -info: - title: DotAAS Part 2 | HTTP/REST | Repository Service Specification (deprecated) - description: "The Read Profile of the Repository Service Specification as part of the Specification of the Asset Administration Shell: Part 2. Publisher: Industrial Digital Twin Association (IDTA) 2023" - contact: - name: Industrial Digital Twin Association (IDTA) - email: info@idtwin.org - license: - name: CC BY 4.0 - url: https://creativecommons.org/licenses/by/4.0/ - version: V3.0_SSP-002 - termsOfService: https://github.com/admin-shell-io/aas-specs -servers: -- url: '{protocol}://{host_name}:{port}/api/{version_prefix}' - variables: - protocol: - description: 'Allows access through http and https (recommended)' - enum: - - 'http' - - 'https' - default: 'https' - host_name: - default: admin-shell.io - description: 'Hostname of server hosting the api' - port: - enum: - - '80' - - '443' - default: '443' - description: '80 is default for http, 443 for https' - version_prefix: - enum: - - 'v3.0' - default: v3.0 -paths: - /shells: - get: - tags: - - Asset Administration Shell Repository API - summary: Returns all Asset Administration Shells - operationId: GetAllAssetAdministrationShells - x-semanticIds: - - https://admin-shell.io/aas/API/GetAllAssetAdministrationShells/3/0 - - https://admin-shell.io/aas/API/GetAllAssetAdministrationShellsByAssetId/3/0 - - https://admin-shell.io/aas/API/GetAllAssetAdministrationShellsByIdShort/3/0 - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/AssetIds' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/IdShort' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Limit' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Cursor' - responses: - '200': - description: Requested Asset Administration Shells - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/GetAssetAdministrationShellsResult' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '401': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/unauthorized' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /shells/$reference: - get: - tags: - - Asset Administration Shell Repository API - summary: Returns References to all Asset Administration Shells - operationId: GetAllAssetAdministrationShells-Reference - x-semanticIds: - - https://admin-shell.io/aas/API/GetAllAssetAdministrationShells/3/0 - - https://admin-shell.io/aas/API/GetAllAssetAdministrationShellsByAssetId/3/0 - - https://admin-shell.io/aas/API/GetAllAssetAdministrationShellsByIdShort/3/0 - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/AssetIds' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/IdShort' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Limit' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Cursor' - responses: - '200': - description: Requested Asset Administration Shells as a list of References - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/GetReferencesResult' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '401': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/unauthorized' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /shells/{aasIdentifier}: - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/AssetAdministrationShellIdentifier' - get: - tags: - - Asset Administration Shell Repository API - summary: Returns a specific Asset Administration Shell - operationId: GetAssetAdministrationShellById - x-semanticIds: - - https://admin-shell.io/aas/API/GetAssetAdministrationShellById/3/0 - responses: - '200': - description: Requested Asset Administration Shell - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0#/components/schemas/AssetAdministrationShell' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '401': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/unauthorized' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /shells/{aasIdentifier}/$reference: - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/AssetAdministrationShellIdentifier' - get: - tags: - - Asset Administration Shell Repository API - summary: Returns a specific Asset Administration Shell as a Reference - operationId: GetAssetAdministrationShellById-Reference - x-semanticIds: - - https://admin-shell.io/aas/API/GetAssetAdministrationShellById/3/0 - responses: - '200': - description: Requested Asset Administration Shell - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0#/components/schemas/Reference' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '401': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/unauthorized' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /shells/{aasIdentifier}/asset-information: - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/AssetAdministrationShellIdentifier' - get: - tags: - - Asset Administration Shell Repository API - summary: Returns the Asset Information - operationId: GetAssetInformation - x-semanticIds: - - https://admin-shell.io/aas/API/GetAssetInformation/3/0 - responses: - '200': - description: Requested Asset Information - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0#/components/schemas/AssetInformation' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '401': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/unauthorized' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /shells/{aasIdentifier}/asset-information/thumbnail: - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/AssetAdministrationShellIdentifier' - get: - tags: - - Asset Administration Shell Repository API - operationId: GetThumbnail - x-semanticIds: - - https://admin-shell.io/aas/API/GetThumbnail/3/0 - responses: - '200': - description: The thumbnail of the Asset Information. - content: - application/octet-stream: - schema: - type: string - format: binary - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '401': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/unauthorized' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /shells/{aasIdentifier}/submodel-refs: - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/AssetAdministrationShellIdentifier' - get: - tags: - - Asset Administration Shell Repository API - summary: Returns all submodel references - operationId: GetAllSubmodelReferences - x-semanticIds: - - https://admin-shell.io/aas/API/GetAllSubmodelReferences/3/0 - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Limit' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Cursor' - responses: - '200': - description: Requested submodel references - content: - application/json: - schema: - type: array - items: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/GetReferencesResult' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '401': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/unauthorized' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /shells/{aasIdentifier}/submodels/{submodelIdentifier}: - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/AssetAdministrationShellIdentifier' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/SubmodelIdentifier' - get: - tags: - - Asset Administration Shell Repository API - summary: Returns the Submodel - operationId: GetSubmodelById_AasRepository - x-semanticIds: - - https://admin-shell.io/aas/API/GetSubmodel/3/0 - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Level' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Extent' - responses: - '200': - description: Requested Submodel - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0#/components/schemas/Submodel' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '401': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/unauthorized' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /shells/{aasIdentifier}/submodels/{submodelIdentifier}/$metadata: - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/AssetAdministrationShellIdentifier' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/SubmodelIdentifier' - get: - tags: - - Asset Administration Shell Repository API - summary: Returns the Submodel's metadata elements - operationId: GetSubmodelById-Metadata_AasRepository - x-semanticIds: - - https://admin-shell.io/aas/API/GetSubmodel/3/0 - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Level' - responses: - '200': - description: Requested Submodel - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/SubmodelMetadata' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '401': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/unauthorized' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /shells/{aasIdentifier}/submodels/{submodelIdentifier}/$value: - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/AssetAdministrationShellIdentifier' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/SubmodelIdentifier' - get: - tags: - - Asset Administration Shell Repository API - summary: Returns the Submodel's ValueOnly representation - operationId: GetSubmodelById-ValueOnly_AasRepository - x-semanticIds: - - https://admin-shell.io/aas/API/GetSubmodel/3/0 - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Level' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Extent' - responses: - '200': - description: Requested Submodel - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/SubmodelValue' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '401': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/unauthorized' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /shells/{aasIdentifier}/submodels/{submodelIdentifier}/$reference: - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/AssetAdministrationShellIdentifier' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/SubmodelIdentifier' - get: - tags: - - Asset Administration Shell Repository API - summary: Returns the Submodel as a Reference - operationId: GetSubmodelById-Reference_AasRepository - x-semanticIds: - - https://admin-shell.io/aas/API/GetSubmodel/3/0 - parameters: - - name: level - in: query - description: Determines the structural depth of the respective resource content - required: false - schema: - type: string - default: core - enum: - # - deep - - core # only 'core' is allowed for Content=Reference - responses: - '200': - description: Requested Submodel as a Reference - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0#/components/schemas/Reference' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '401': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/unauthorized' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - - /shells/{aasIdentifier}/submodels/{submodelIdentifier}/$path: - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/AssetAdministrationShellIdentifier' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/SubmodelIdentifier' - get: - tags: - - Asset Administration Shell Repository API - summary: Returns the Submodel's metadata elements - operationId: GetSubmodelById-Path_AasRepository - x-semanticIds: - - https://admin-shell.io/aas/API/GetSubmodel/3/0 - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Level' - responses: - '200': - description: Requested Submodel in Path notation - content: - application/json: - schema: - type: array - items: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/PathItem' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '401': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/unauthorized' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /shells/{aasIdentifier}/submodels/{submodelIdentifier}/submodel-elements: - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/AssetAdministrationShellIdentifier' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/SubmodelIdentifier' - get: - tags: - - Asset Administration Shell Repository API - summary: Returns all submodel elements including their hierarchy - operationId: GetAllSubmodelElements_AasRepository - x-semanticIds: - - https://admin-shell.io/aas/API/GetAllSubmodelElements/3/0 - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Limit' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Cursor' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Level' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Extent' - responses: - '200': - description: List of found submodel elements - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/GetSubmodelElementsResult' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '401': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/unauthorized' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /shells/{aasIdentifier}/submodels/{submodelIdentifier}/submodel-elements/$metadata: - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/AssetAdministrationShellIdentifier' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/SubmodelIdentifier' - get: - tags: - - Asset Administration Shell Repository API - summary: Returns all submodel elements including their hierarchy - operationId: GetAllSubmodelElements-Metadata - x-semanticIds: - - https://admin-shell.io/aas/API/GetAllSubmodelElements/3/0 - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Limit' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Cursor' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Level' - responses: - '200': - description: List of found submodel elements - content: - application/json: - schema: - type: array - items: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/GetSubmodelElementsMetadataResult' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '401': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/unauthorized' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /shells/{aasIdentifier}/submodels/{submodelIdentifier}/submodel-elements/$value: - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/AssetAdministrationShellIdentifier' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/SubmodelIdentifier' - get: - tags: - - Asset Administration Shell Repository API - summary: Returns all submodel elements including their hierarchy in the ValueOnly representation - operationId: GetAllSubmodelElements-ValueOnly - x-semanticIds: - - https://admin-shell.io/aas/API/GetAllSubmodelElements/3/0 - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Limit' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Cursor' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Level' - responses: - '200': - description: List of found submodel elements in their ValueOnly representation - content: - application/json: - schema: - type: array - items: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/GetSubmodelElementsValueResult' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '401': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/unauthorized' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /shells/{aasIdentifier}/submodels/{submodelIdentifier}/submodel-elements/$reference: - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/AssetAdministrationShellIdentifier' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/SubmodelIdentifier' - get: - tags: - - Asset Administration Shell Repository API - summary: Returns all submodel elements as a list of References - operationId: GetAllSubmodelElements-Reference - x-semanticIds: - - https://admin-shell.io/aas/API/GetAllSubmodelElements/3/0 - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Limit' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Cursor' - - name: level - in: query - description: Determines the structural depth of the respective resource content - required: false - schema: - type: string - default: core - enum: - # - deep - - core # only 'core' is allowed for Content=Reference - responses: - '200': - description: List of References of the found submodel elements - content: - application/json: - schema: - type: array - items: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/GetReferencesResult' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '401': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/unauthorized' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /shells/{aasIdentifier}/submodels/{submodelIdentifier}/submodel-elements/$path: - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/AssetAdministrationShellIdentifier' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/SubmodelIdentifier' - get: - tags: - - Asset Administration Shell Repository API - summary: Returns all submodel elements including their hierarchy - operationId: GetAllSubmodelElements-Path - x-semanticIds: - - https://admin-shell.io/aas/API/GetAllSubmodelElements/3/0 - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Limit' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Cursor' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Level' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Extent' - responses: - '200': - description: List of found submodel elements in the Path notation - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/GetPathItemsResult' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '401': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/unauthorized' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /shells/{aasIdentifier}/submodels/{submodelIdentifier}/submodel-elements/{idShortPath}: - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/AssetAdministrationShellIdentifier' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/SubmodelIdentifier' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/IdShortPath' - get: - tags: - - Asset Administration Shell Repository API - summary: Returns a specific submodel element from the Submodel at a specified - path - operationId: GetSubmodelElementByPath - x-semanticIds: - - https://admin-shell.io/aas/API/GetSubmodelElementByPath/3/0 - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Limit' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Cursor' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Level' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Extent' - responses: - '200': - description: Requested submodel element - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/GetSubmodelElementsResult' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '401': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/unauthorized' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /shells/{aasIdentifier}/submodels/{submodelIdentifier}/submodel-elements/{idShortPath}/$metadata: - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/AssetAdministrationShellIdentifier' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/SubmodelIdentifier' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/IdShortPath' - get: - tags: - - Asset Administration Shell Repository API - summary: Returns the metadata attributes if a specific submodel element from the Submodel at a specified - path - operationId: GetSubmodelElementByPath-Metadata - x-semanticIds: - - https://admin-shell.io/aas/API/GetSubmodelElementByPath/3/0 - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Limit' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Cursor' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Level' - responses: - '200': - description: Requested submodel element - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/GetSubmodelElementsMetadataResult' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '401': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/unauthorized' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /shells/{aasIdentifier}/submodels/{submodelIdentifier}/submodel-elements/{idShortPath}/$value: - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/AssetAdministrationShellIdentifier' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/SubmodelIdentifier' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/IdShortPath' - get: - tags: - - Asset Administration Shell Repository API - summary: Returns a specific submodel element from the Submodel at a specified - path in the ValueOnly representation - operationId: GetSubmodelElementByPath-ValueOnly - x-semanticIds: - - https://admin-shell.io/aas/API/GetSubmodelElementByPath/3/0 - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Limit' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Cursor' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Level' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Extent' - responses: - '200': - description: Requested submodel element in its ValueOnly representation - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/GetSubmodelElementsValueResult' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '401': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/unauthorized' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /shells/{aasIdentifier}/submodels/{submodelIdentifier}/submodel-elements/{idShortPath}/$reference: - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/AssetAdministrationShellIdentifier' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/SubmodelIdentifier' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/IdShortPath' - get: - tags: - - Asset Administration Shell Repository API - summary: Returns the Reference of a specific submodel element from the Submodel at a specified path - operationId: GetSubmodelElementByPath-Reference - x-semanticIds: - - https://admin-shell.io/aas/API/GetSubmodelElementByPath/3/0 - parameters: - - name: level - in: query - description: Determines the structural depth of the respective resource content - required: false - schema: - type: string - default: core - enum: - # - deep - - core # only 'core' is allowed for Content=Reference - responses: - '200': - description: Requested submodel element in its ValueOnly representation - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0#/components/schemas/Reference' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '401': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/unauthorized' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /shells/{aasIdentifier}/submodels/{submodelIdentifier}/submodel-elements/{idShortPath}/$path: - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/AssetAdministrationShellIdentifier' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/SubmodelIdentifier' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/IdShortPath' - get: - tags: - - Asset Administration Shell Repository API - summary: Returns a specific submodel element from the Submodel at a specified path in the Path notation - operationId: GetSubmodelElementByPath-Path - x-semanticIds: - - https://admin-shell.io/aas/API/GetSubmodelElementByPath/3/0 - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Level' - responses: - '200': - description: Requested submodel element in the Path notation - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/PathItem' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '401': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/unauthorized' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /shells/{aasIdentifier}/submodels/{submodelIdentifier}/submodel-elements/{idShortPath}/attachment: - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/AssetAdministrationShellIdentifier' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/SubmodelIdentifier' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/IdShortPath' - get: - tags: - - Asset Administration Shell Repository API - summary: Downloads file content from a specific submodel element from the Submodel at a specified path - operationId: GetFileByPath - x-semanticIds: - - https://admin-shell.io/aas/API/GetFileByPath/3/0 - responses: - '200': - description: Requested file - headers: - Content-Disposition: - schema: - type: string - description: In order to physically download the file usually set to attachment with a filename - example: 'attachment; filename="filename.jpg"' - content: - application/octet-stream: - schema: - type: string - format: binary - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '401': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/unauthorized' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - - /submodels: - get: - tags: - - Submodel Repository API - summary: Returns all Submodels - operationId: GetAllSubmodels - x-semanticIds: - - https://admin-shell.io/aas/API/GetAllSubmodels/3/0 - - https://admin-shell.io/aas/API/GetAllSubmodelsBySemanticId/3/0 - - https://admin-shell.io/aas/API/GetAllSubmodelsByIdShort/3/0 - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/SemanticId' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/IdShort' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Limit' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Cursor' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Level' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Extent' - responses: - '200': - description: Requested Submodels - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/GetSubmodelsResult' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '401': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/unauthorized' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /submodels/$metadata: - get: - tags: - - Submodel Repository API - summary: Returns the metadata attributes of all Submodels - operationId: GetAllSubmodels-Metadata - x-semanticIds: - - https://admin-shell.io/aas/API/GetAllSubmodels/3/0 - - https://admin-shell.io/aas/API/GetAllSubmodelsBySemanticId/3/0 - - https://admin-shell.io/aas/API/GetAllSubmodelsByIdShort/3/0 - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/SemanticId' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/IdShort' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Limit' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Cursor' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Level' - responses: - '200': - description: Requested Submodels - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/GetSubmodelsMetadataResult' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '401': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/unauthorized' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /submodels/$value: - get: - tags: - - Submodel Repository API - summary: Returns all Submodels in their ValueOnly representation - operationId: GetAllSubmodels-ValueOnly - x-semanticIds: - - https://admin-shell.io/aas/API/GetAllSubmodels/3/0 - - https://admin-shell.io/aas/API/GetAllSubmodelsBySemanticId/3/0 - - https://admin-shell.io/aas/API/GetAllSubmodelsByIdShort/3/0 - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/SemanticId' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/IdShort' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Limit' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Cursor' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Level' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Extent' - responses: - '200': - description: Requested Submodels - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/GetSubmodelsValueResult' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '401': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/unauthorized' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /submodels/$reference: - get: - tags: - - Submodel Repository API - summary: Returns the References for all Submodels - operationId: GetAllSubmodels-Reference - x-semanticIds: - - https://admin-shell.io/aas/API/GetAllSubmodels/3/0 - - https://admin-shell.io/aas/API/GetAllSubmodelsBySemanticId/3/0 - - https://admin-shell.io/aas/API/GetAllSubmodelsByIdShort/3/0 - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/SemanticId' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/IdShort' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Limit' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Cursor' - - name: level - in: query - description: Determines the structural depth of the respective resource content - required: false - schema: - type: string - default: core - enum: - # - deep - - core # only 'core' is allowed for Content=Reference - responses: - '200': - description: References of the requested Submodels - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/GetReferencesResult' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '401': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/unauthorized' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /submodels/$path: - get: - tags: - - Submodel Repository API - summary: Returns all Submodels in the Path notation - operationId: GetAllSubmodels-Path - x-semanticIds: - - https://admin-shell.io/aas/API/GetAllSubmodels/3/0 - - https://admin-shell.io/aas/API/GetAllSubmodelsBySemanticId/3/0 - - https://admin-shell.io/aas/API/GetAllSubmodelsByIdShort/3/0 - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/SemanticId' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/IdShort' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Limit' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Cursor' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Level' - responses: - '200': - description: Requested Submodels - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/GetPathItemsResult' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '401': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/unauthorized' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /submodels/{submodelIdentifier}: - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/SubmodelIdentifier' - get: - tags: - - Submodel Repository API - summary: Returns a specific Submodel - operationId: GetSubmodelById - x-semanticIds: - - https://admin-shell.io/aas/API/GetSubmodelById/3/0 - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Level' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Extent' - responses: - '200': - description: Requested Submodel - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0#/components/schemas/Submodel' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '401': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/unauthorized' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /submodels/{submodelIdentifier}/$metadata: - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/SubmodelIdentifier' - get: - tags: - - Submodel Repository API - summary: Returns the metadata attributes of a specific Submodel - operationId: GetSubmodelById-Metadata - x-semanticIds: - - https://admin-shell.io/aas/API/GetSubmodelById/3/0 - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Level' - responses: - '200': - description: Requested Submodel in the metadata representation - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/SubmodelMetadata' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '401': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/unauthorized' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /submodels/{submodelIdentifier}/$value: - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/SubmodelIdentifier' - get: - tags: - - Submodel Repository API - summary: Returns a specific Submodel in the ValueOnly representation - operationId: GetSubmodelById-ValueOnly - x-semanticIds: - - https://admin-shell.io/aas/API/GetSubmodelById/3/0 - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Level' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Extent' - responses: - '200': - description: Requested Submodel - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/SubmodelValue' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '401': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/unauthorized' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /submodels/{submodelIdentifier}/$reference: - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/SubmodelIdentifier' - get: - tags: - - Submodel Repository API - summary: Returns the Reference of a specific Submodel - operationId: GetSubmodelById-Reference - x-semanticIds: - - https://admin-shell.io/aas/API/GetSubmodelById/3/0 - parameters: - - name: level - in: query - description: Determines the structural depth of the respective resource content - required: false - schema: - type: string - default: core - enum: - # - deep - - core # only 'core' is allowed for Content=Reference - responses: - '200': - description: Requested Submodel - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0#/components/schemas/Reference' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '401': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/unauthorized' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /submodels/{submodelIdentifier}/$path: - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/SubmodelIdentifier' - get: - tags: - - Submodel Repository API - summary: Returns a specific Submodel in the Path notation - operationId: GetSubmodelById-Path - x-semanticIds: - - https://admin-shell.io/aas/API/GetSubmodelById/3/0 - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Level' - responses: - '200': - description: Requested Submodel - content: - application/json: - schema: - type: array - items: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/PathItem' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '401': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/unauthorized' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /submodels/{submodelIdentifier}/submodel-elements: - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/SubmodelIdentifier' - get: - tags: - - Submodel Repository API - summary: Returns all submodel elements including their hierarchy - operationId: GetAllSubmodelElements - x-semanticIds: - - https://admin-shell.io/aas/API/GetAllSubmodelElements/3/0 - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Limit' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Cursor' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Level' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Extent' - responses: - '200': - description: List of found submodel elements - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/GetSubmodelElementsResult' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '401': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/unauthorized' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - description: Default error handling for unmentioned status codes - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/Result' - /submodels/{submodelIdentifier}/submodel-elements/$metadata: - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/SubmodelIdentifier' - get: - tags: - - Submodel Repository API - summary: Returns the metadata attributes of all submodel elements including their hierarchy - operationId: GetAllSubmodelElements-Metadata_SubmodelRepo - x-semanticIds: - - https://admin-shell.io/aas/API/GetAllSubmodelElements/3/0 - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Limit' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Cursor' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Level' - responses: - '200': - description: List of found submodel elements - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/GetSubmodelElementsMetadataResult' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '401': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/unauthorized' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /submodels/{submodelIdentifier}/submodel-elements/$value: - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/SubmodelIdentifier' - get: - tags: - - Submodel Repository API - summary: Returns all submodel elements including their hierarchy in the ValueOnly representation - operationId: GetAllSubmodelElements-ValueOnly_SubmodelRepo - x-semanticIds: - - https://admin-shell.io/aas/API/GetAllSubmodelElements/3/0 - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Limit' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Cursor' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Level' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Extent' - responses: - '200': - description: List of found submodel elements - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/GetSubmodelElementsValueResult' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '401': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/unauthorized' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /submodels/{submodelIdentifier}/submodel-elements/$reference: - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/SubmodelIdentifier' - get: - tags: - - Submodel Repository API - summary: Returns the References of all submodel elements - operationId: GetAllSubmodelElements-Reference_SubmodelRepo - x-semanticIds: - - https://admin-shell.io/aas/API/GetAllSubmodelElements/3/0 - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Limit' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Cursor' - - name: level - in: query - description: Determines the structural depth of the respective resource content - required: false - schema: - type: string - default: core - enum: - # - deep - - core # only 'core' is allowed for Content=Reference - responses: - '200': - description: List of found submodel elements - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/GetReferencesResult' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '401': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/unauthorized' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /submodels/{submodelIdentifier}/submodel-elements/$path: - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/SubmodelIdentifier' - get: - tags: - - Submodel Repository API - summary: Returns all submodel elements including their hierarchy in the Path notation - operationId: GetAllSubmodelElements-Path_SubmodelRepo - x-semanticIds: - - https://admin-shell.io/aas/API/GetAllSubmodelElements/3/0 - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Limit' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Cursor' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Level' - responses: - '200': - description: List of found submodel elements in the Path notation - content: - application/json: - schema: - type: array - items: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/GetPathItemsResult' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '401': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/unauthorized' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /submodels/{submodelIdentifier}/submodel-elements/{idShortPath}: - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/SubmodelIdentifier' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/IdShortPath' - get: - tags: - - Submodel Repository API - summary: Returns a specific submodel element from the Submodel at a specified - path - operationId: GetSubmodelElementByPath_SubmodelRepo - x-semanticIds: - - https://admin-shell.io/aas/API/GetSubmodelElementByPath/3/0 - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Level' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Extent' - responses: - '200': - description: Requested submodel element - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0#/components/schemas/SubmodelElement' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '401': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/unauthorized' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /submodels/{submodelIdentifier}/submodel-elements/{idShortPath}/$metadata: - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/SubmodelIdentifier' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/IdShortPath' - get: - tags: - - Submodel Repository API - summary: Returns the matadata attributes of a specific submodel element from the Submodel at a specified - path - operationId: GetSubmodelElementByPath-Metadata_SubmodelRepo - x-semanticIds: - - https://admin-shell.io/aas/API/GetSubmodelElementByPath/3/0 - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Level' - responses: - '200': - description: Metadata attributes of the requested submodel element - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/SubmodelElementMetadata' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '401': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/unauthorized' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /submodels/{submodelIdentifier}/submodel-elements/{idShortPath}/$value: - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/SubmodelIdentifier' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/IdShortPath' - get: - tags: - - Submodel Repository API - summary: Returns a specific submodel element from the Submodel at a specified - path in the ValueOnly representation - operationId: GetSubmodelElementByPath-ValueOnly_SubmodelRepo - x-semanticIds: - - https://admin-shell.io/aas/API/GetSubmodelElementByPath/3/0 - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Level' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Extent' - responses: - '200': - description: Requested submodel element - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/SubmodelElementValue' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '401': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/unauthorized' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /submodels/{submodelIdentifier}/submodel-elements/{idShortPath}/$reference: - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/SubmodelIdentifier' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/IdShortPath' - get: - tags: - - Submodel Repository API - summary: Returns the Referene of a specific submodel element from the Submodel at a specified - path - operationId: GetSubmodelElementByPath-Reference_SubmodelRepo - x-semanticIds: - - https://admin-shell.io/aas/API/GetSubmodelElementByPath/3/0 - parameters: - - name: level - in: query - description: Determines the structural depth of the respective resource content - required: false - schema: - type: string - default: core - enum: - # - deep - - core # only 'core' is allowed for Content=Reference - responses: - '200': - description: Requested submodel element - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0#/components/schemas/Reference' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '401': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/unauthorized' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /submodels/{submodelIdentifier}/submodel-elements/{idShortPath}/$path: - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/SubmodelIdentifier' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/IdShortPath' - get: - tags: - - Submodel Repository API - summary: Returns a specific submodel element from the Submodel at a specified - path in the Path notation - operationId: GetSubmodelElementByPath-Path_SubmodelRepo - x-semanticIds: - - https://admin-shell.io/aas/API/GetSubmodelElementByPath/3/0 - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Level' - responses: - '200': - description: Requested submodel element - content: - application/json: - schema: - type: array - items: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/PathItem' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '401': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/unauthorized' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /submodels/{submodelIdentifier}/submodel-elements/{idShortPath}/attachment: - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/SubmodelIdentifier' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/IdShortPath' - get: - tags: - - Submodel Repository API - summary: Downloads file content from a specific submodel element from the Submodel at a specified path - operationId: GetFileByPath_SubmodelRepo - x-semanticIds: - - https://admin-shell.io/aas/API/GetFileByPath/3/0 - responses: - '200': - description: Requested file - headers: - Content-Disposition: - schema: - type: string - description: In order to physically download the file usually set to attachment with a filename - example: 'attachment; filename="filename.jpg"' - content: - application/octet-stream: - schema: - type: string - format: binary - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '401': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/unauthorized' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '405': - description: Method not allowed - Download only valid for File submodel element - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/Result' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - - /serialization: - get: - tags: - - Serialization API - summary: Returns an appropriate serialization based on the specified format (see SerializationFormat) - operationId: GenerateSerializationByIds - x-semanticIds: - - https://admin-shell.io/aas/API/GenerateSerializationByIds/3/0 - parameters: - - name: aasIds - in: query - description: The Asset Administration Shells' unique ids (UTF8-BASE64-URL-encoded) - style: form - explode: true - schema: - type: array - items: - type: string - - name: submodelIds - in: query - description: The Submodels' unique ids (UTF8-BASE64-URL-encoded) - style: form - explode: true - schema: - type: array - items: - type: string - - name: includeConceptDescriptions - in: query - description: Include Concept Descriptions? - style: form - explode: true - schema: - type: boolean - default: true - responses: - '200': - description: Requested serialization based on SerializationFormat - content: - application/asset-administration-shell-package+xml: - schema: - description: AASX package - type: string - format: binary - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0#/components/schemas/Environment' - application/xml: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0#/components/schemas/Environment' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '401': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/unauthorized' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /description: - get: - tags: - - Description API - summary: Returns the self-describing information of a network resource (ServiceDescription) - operationId: GetDescription - x-semanticIds: - - https://admin-shell.io/aas/API/Descriptor/GetDescription/3/0 - responses: - '200': - description: Requested Description - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/ServiceDescription' - '401': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/unauthorized' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' \ No newline at end of file diff --git a/Submodel-API/openapi.yaml b/Submodel-API/openapi.yaml deleted file mode 100644 index 8da3aac7..00000000 --- a/Submodel-API/openapi.yaml +++ /dev/null @@ -1,549 +0,0 @@ -openapi: 3.0.3 -info: - title: DotAAS Part 2 | HTTP/REST | Submodel API - description: An exemplary API for the use case of a standalone hosted Submodel, e.g., a Submodel running in a Docker container - contact: - name: Constantin Ziesche, Andreas Orzelski, Florian Krebs, Bastian Rössl, Manuel Sauer, Jens Vialkowitsch, Michael Hoffmeister, Torben Miny, Sebastian Bader, Marko Ristin, Nico Braunisch - version: V1.0RC03 - termsOfService: https://github.com/admin-shell-io/aas-specs -servers: -- url: '{protocol}://{host_name}:{port}/api/{version_prefix}' - variables: - protocol: - description: 'Allows access through http and https (recommended)' - enum: - - 'http' - - 'https' - default: 'https' - host_name: - default: admin-shell.io - description: 'Hostname of server hosting the api' - port: - enum: - - '80' - - '443' - default: '443' - description: '80 is default for http, 443 for https' - version_prefix: - enum: - - 'v1' - default: v1 -paths: - /submodel: - get: - tags: - - Submodel API - summary: Returns the Submodel - operationId: GetSubmodel - x-semanticIds: - - https://admin-shell.io/aas/API/GetSubmodel/1/0/RC03 - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V1.0RC03#/components/parameters/Level' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V1.0RC03#/components/parameters/Content' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V1.0RC03#/components/parameters/Extent' - responses: - '200': - description: Requested Submodel - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0RC02#/components/schemas/Submodel' - default: - description: Default error handling for unmentioned status codes - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V1.0RC03#/components/schemas/Result' - put: - tags: - - Submodel API - summary: Updates the Submodel - operationId: PutSubmodel - x-semanticIds: - - https://admin-shell.io/aas/API/PutSubmodel/1/0/RC03 - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V1.0RC03#/components/parameters/Level' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V1.0RC03#/components/parameters/Content' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V1.0RC03#/components/parameters/Extent' - requestBody: - description: Submodel object - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0RC02#/components/schemas/Submodel' - required: true - responses: - '204': - description: Submodel updated successfully - '400': - description: Bad Request - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V1.0RC03#/components/schemas/Result' - default: - description: Default error handling for unmentioned status codes - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V1.0RC03#/components/schemas/Result' - /submodel/submodel-elements: - get: - tags: - - Submodel API - summary: Returns all submodel elements including their hierarchy - operationId: GetAllSubmodelElements - x-semanticIds: - - https://admin-shell.io/aas/API/GetAllSubmodelElements/1/0/RC03 - - https://admin-shell.io/aas/API/GetAllSubmodelElementsBySemanticId/1/0/RC03 - - https://admin-shell.io/aas/API/GetAllSubmodelElementsByParentPathAndSemanticId/1/0/RC03 - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V1.0RC03#/components/parameters/Level' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V1.0RC03#/components/parameters/Content' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V1.0RC03#/components/parameters/Extent' - responses: - '200': - description: List of found submodel elements - content: - application/json: - schema: - type: array - items: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0RC02#/components/schemas/SubmodelElement' - default: - description: Default error handling for unmentioned status codes - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V1.0RC03#/components/schemas/Result' - post: - tags: - - Submodel API - summary: Creates a new submodel element - operationId: PostSubmodelElement - x-semanticIds: - - https://admin-shell.io/aas/API/PostSubmodelElement/1/0/RC03c - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V1.0RC03#/components/parameters/Level' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V1.0RC03#/components/parameters/Content' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V1.0RC03#/components/parameters/Extent' - requestBody: - description: Requested submodel element - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0RC02#/components/schemas/SubmodelElement' - required: true - responses: - '201': - description: Submodel element created successfully - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0RC02#/components/schemas/SubmodelElement' - '400': - description: Bad Request - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V1.0RC03#/components/schemas/Result' - default: - description: Default error handling for unmentioned status codes - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V1.0RC03#/components/schemas/Result' - /submodel/submodel-elements/{idShortPath}: - get: - tags: - - Submodel API - summary: Returns a specific submodel element from the Submodel at a specified - path - operationId: GetSubmodelElementByPath - x-semanticIds: - - https://admin-shell.io/aas/API/GetSubmodelElementByPath/1/0/RC03 - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V1.0RC03#/components/parameters/Level' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V1.0RC03#/components/parameters/Content' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V1.0RC03#/components/parameters/Extent' - - name: idShortPath - in: path - description: IdShort path to the submodel element (dot-separated) - required: true - style: simple - explode: false - schema: - type: string - responses: - '200': - description: Requested submodel element - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0RC02#/components/schemas/SubmodelElement' - '404': - description: Not Found - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V1.0RC03#/components/schemas/Result' - default: - description: Default error handling for unmentioned status codes - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V1.0RC03#/components/schemas/Result' - post: - tags: - - Submodel API - summary: Creates a new submodel element at a specified path within submodel elements hierarchy - operationId: PostSubmodelElementByPath - x-semanticIds: - - https://admin-shell.io/aas/API/PostSubmodelElementByPath/1/0/RC03c - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V1.0RC03#/components/parameters/Level' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V1.0RC03#/components/parameters/Content' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V1.0RC03#/components/parameters/Extent' - - name: idShortPath - in: path - description: IdShort path to the submodel element (dot-separated) - required: true - style: simple - explode: false - schema: - type: string - requestBody: - description: Requested submodel element - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0RC02#/components/schemas/SubmodelElement' - required: true - responses: - '201': - description: Submodel element created successfully - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0RC02#/components/schemas/SubmodelElement' - '400': - description: Bad Request - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V1.0RC03#/components/schemas/Result' - '404': - description: Not Found - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V1.0RC03#/components/schemas/Result' - default: - description: Default error handling for unmentioned status codes - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V1.0RC03#/components/schemas/Result' - put: - tags: - - Submodel API - summary: Updates an existing submodel element at a specified path within submodel elements hierarchy - operationId: PutSubmodelElementByPath - x-semanticIds: - - https://admin-shell.io/aas/API/PutSubmodelElementByPath/1/0/RC03 - - https://admin-shell.io/aas/API/SetSubmodelElementValueByPath/1/0/RC03 - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V1.0RC03#/components/parameters/Level' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V1.0RC03#/components/parameters/Content' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V1.0RC03#/components/parameters/Extent' - - name: idShortPath - in: path - description: IdShort path to the submodel element (dot-separated) - required: true - style: simple - explode: false - schema: - type: string - requestBody: - description: Requested submodel element - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0RC02#/components/schemas/SubmodelElement' - required: true - responses: - '204': - description: Submodel element updated successfully - '400': - description: Bad Request - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V1.0RC03#/components/schemas/Result' - '404': - description: Not Found - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V1.0RC03#/components/schemas/Result' - default: - description: Default error handling for unmentioned status codes - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V1.0RC03#/components/schemas/Result' - delete: - tags: - - Submodel API - summary: Deletes a submodel element at a specified path within the submodel elements hierarchy - operationId: DeleteSubmodelElementByPath - x-semanticIds: - - https://admin-shell.io/aas/API/DeleteSubmodelElementByPath/1/0/RC03 - parameters: - - name: idShortPath - in: path - description: IdShort path to the submodel element (dot-separated) - required: true - style: simple - explode: false - schema: - type: string - responses: - '204': - description: Submodel element deleted successfully - '404': - description: Not Found - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V1.0RC03#/components/schemas/Result' - default: - description: Default error handling for unmentioned status codes - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V1.0RC03#/components/schemas/Result' - /submodel/submodel-elements/{idShortPath}/attachment: - get: - tags: - - Submodel API - summary: Downloads file content from a specific submodel element from the Submodel at a specified path - operationId: GetFileByPath - x-semanticIds: - - https://admin-shell.io/aas/API/GetFileByPath/1/0/RC03 - parameters: - - name: idShortPath - in: path - description: IdShort path to the submodel element (dot-separated) - required: true - style: simple - explode: false - schema: - type: string - responses: - '200': - description: Requested file - headers: - Content-Disposition: - schema: - type: string - description: In order to physically download the file usually set to attachment with a filename - example: 'attachment; filename="filename.jpg"' - content: - application/octet-stream: - schema: - type: string - format: binary - '404': - description: Not Found - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V1.0RC03#/components/schemas/Result' - '405': - description: Method not allowed - Download only valid for File submodel element - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V1.0RC03#/components/schemas/Result' - default: - description: Default error handling for unmentioned status codes - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V1.0RC03#/components/schemas/Result' - put: - tags: - - Submodel API - summary: Uploads file content to an existing submodel element at a specified path within submodel elements hierarchy - operationId: PutFileByPath - x-semanticIds: - - https://admin-shell.io/aas/API/PutFileByPath/1/0/RC03 - parameters: - - name: idShortPath - in: path - description: IdShort path to the submodel element (dot-separated) - required: true - style: simple - explode: false - schema: - type: string - requestBody: - description: File to upload - content: - multipart/form-data: - schema: - type: object - properties: - fileName: - type: string - file: - type: string - format: binary - encoding: - file: - contentType: application/octet-stream - required: true - responses: - '204': - description: Submodel element updated successfully - '400': - description: Bad Request - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V1.0RC03#/components/schemas/Result' - '404': - description: Not Found - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V1.0RC03#/components/schemas/Result' - '405': - description: Method not allowed - Upload only valid for File submodel element - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V1.0RC03#/components/schemas/Result' - default: - description: Default error handling for unmentioned status codes - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V1.0RC03#/components/schemas/Result' - /submodel/submodel-elements/{idShortPath}/invoke: - post: - tags: - - Submodel API - summary: Synchronously or asynchronously invokes an Operation at a specified path - operationId: InvokeOperation - x-semanticIds: - - https://admin-shell.io/aas/API/InvokeOperationSync/1/0/RC03 - - https://admin-shell.io/aas/API/InvokeOperationAsync/1/0/RC03 - parameters: - - name: async - in: query - description: Determines whether an operation invocation is performed asynchronously or synchronously - schema: - type: boolean - default: false - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V1.0RC03#/components/parameters/Content' - - name: idShortPath - in: path - description: IdShort path to the submodel element (dot-separated), in this case an operation - required: true - style: simple - explode: false - schema: - type: string - requestBody: - description: Operation request object - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V1.0RC03#/components/schemas/OperationRequest' - required: true - responses: - '200': - description: Operation result object - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V1.0RC03#/components/schemas/OperationResult' - '400': - description: Bad Request - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V1.0RC03#/components/schemas/Result' - '404': - description: Not Found - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V1.0RC03#/components/schemas/Result' - '405': - description: Method not allowed - Invoke only valid for Operation submodel element - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V1.0RC03#/components/schemas/Result' - default: - description: Default error handling for unmentioned status codes - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V1.0RC03#/components/schemas/Result' - /submodel/submodel-elements/{idShortPath}/operation-results/{handleId}: - get: - tags: - - Submodel API - summary: Returns the Operation result of an asynchronous invoked Operation - operationId: GetOperationAsyncResult - x-semanticIds: - - https://admin-shell.io/aas/API/GetOperationAsyncResult/1/0/RC03 - parameters: - - name: content - in: query - schema: - type: string - default: normal - enum: - - normal - - value - - name: idShortPath - in: path - description: IdShort path to the submodel element (dot-separated), in this case an operation - required: true - style: simple - explode: false - schema: - type: string - - name: handleId - in: path - description: The returned handle id of an operation’s asynchronous invocation used to request the current state of the operation’s execution (UTF8-BASE64-URL-encoded) - required: true - style: simple - explode: false - schema: - type: string - format: byte - responses: - '200': - description: Operation result object - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V1.0RC03#/components/schemas/OperationResult' - '404': - description: Not Found - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V1.0RC03#/components/schemas/Result' - default: - description: Default error handling for unmentioned status codes - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V1.0RC03#/components/schemas/Result' \ No newline at end of file diff --git a/SubmodelRepositoryServiceSpecification/V3.0-MinimalProfile.yaml b/SubmodelRepositoryServiceSpecification/V3.0-MinimalProfile.yaml deleted file mode 100644 index ba7f204a..00000000 --- a/SubmodelRepositoryServiceSpecification/V3.0-MinimalProfile.yaml +++ /dev/null @@ -1,281 +0,0 @@ -openapi: 3.0.3 -info: - title: DotAAS Part 2 | HTTP/REST | Submodel Repository Service Specification - Minimal Profile - description: The minimal profile of the Submodel Repository Service Specification as part of Details of the Asset Administration Shell Part 2 - contact: - name: Constantin Ziesche, Andreas Orzelski, Florian Krebs, Bastian Rössl, Manuel Sauer, Jens Vialkowitsch, Michael Hoffmeister, Torben Miny, Sebastian Bader, Marko Ristin, Nico Braunisch - version: V3.0-MinimalProfile - termsOfService: https://github.com/admin-shell-io/aas-specs -servers: -- url: '{protocol}://{host_name}:{port}/api/{version_prefix}' - variables: - protocol: - description: 'Allows access through http and https (recommended)' - enum: - - 'http' - - 'https' - default: 'https' - host_name: - default: admin-shell.io - description: 'Hostname of server hosting the api' - port: - enum: - - '80' - - '443' - default: '443' - description: '80 is default for http, 443 for https' - version_prefix: - enum: - - 'v3.0' - default: v3.0 -paths: - /submodels: - get: - tags: - - Submodel Repository API - summary: Returns all Submodels - operationId: GetAllSubmodels - x-semanticIds: - - https://admin-shell.io/aas/API/GetAllSubmodels/3/0 - - https://admin-shell.io/aas/API/GetAllSubmodelsBySemanticId/3/0 - - https://admin-shell.io/aas/API/GetAllSubmodelsByIdShort/3/0 - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/SemanticId' - - name: idShort - in: query - description: The Submodel’s idShort - required: false - style: form - explode: true - schema: - type: string - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Extent' - responses: - '200': - description: Requested Submodels - content: - application/json: - schema: - type: array - items: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0#/components/schemas/Submodel' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - post: - tags: - - Submodel Repository API - summary: Creates a new Submodel - operationId: PostSubmodel - x-semanticIds: - - https://admin-shell.io/aas/API/PostSubmodel/3/0 - requestBody: - description: Submodel object - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0#/components/schemas/Submodel' - required: true - responses: - '201': - description: Submodel created successfully - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0#/components/schemas/Submodel' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '409': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/conflict' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /submodels/{submodelIdentifier}: - get: - tags: - - Submodel Repository API - summary: Returns a specific Submodel - operationId: GetSubmodelById - x-semanticIds: - - https://admin-shell.io/aas/API/GetSubmodelById/3/0 - parameters: - - name: submodelIdentifier - in: path - description: The Submodel’s unique id (UTF8-BASE64-URL-encoded) - required: true - style: simple - explode: false - schema: - type: string - format: byte - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Extent' - responses: - '200': - description: Requested Submodel - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0#/components/schemas/Submodel' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - put: - tags: - - Submodel Repository API - summary: Updates an existing Submodel - operationId: PutSubmodelById - x-semanticIds: - - https://admin-shell.io/aas/API/PutSubmodelById/3/0 - parameters: - - name: submodelIdentifier - in: path - description: The Submodel’s unique id (UTF8-BASE64-URL-encoded) - required: true - style: simple - explode: false - schema: - type: string - format: byte - #- $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Level' - - name: level - in: query - description: Determines the structural depth of the respective resource content - required: false - schema: - type: string - default: deep - enum: - - deep # only 'deep' is allowed for PUT - #- core - requestBody: - description: Submodel object - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0#/components/schemas/Submodel' - required: true - responses: - '204': - description: Submodel updated successfully - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - patch: - tags: - - Submodel Repository API - summary: Updates an existing Submodel - operationId: PatchSubmodelById - x-semanticIds: - - https://admin-shell.io/aas/API/PatchSubmodelById/3/0 - parameters: - - name: submodelIdentifier - in: path - description: The Submodel’s unique id (UTF8-BASE64-URL-encoded) - required: true - style: simple - explode: false - schema: - type: string - format: byte - #- $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Level' - - name: level - in: query - description: Determines the structural depth of the respective resource content - required: false - schema: - type: string - default: core - enum: - #- deep - - core # only 'core' is allowed for PATCH - requestBody: - description: Submodel object - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0#/components/schemas/Submodel' - required: true - responses: - '204': - description: Submodel updated successfully - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - delete: - tags: - - Submodel Repository API - summary: Deletes a Submodel - operationId: DeleteSubmodelById - x-semanticIds: - - https://admin-shell.io/aas/API/DeleteSubmodelById/3/0 - parameters: - - name: submodelIdentifier - in: path - description: The Submodel’s unique id (UTF8-BASE64-URL-encoded) - required: true - style: simple - explode: false - schema: - type: string - format: byte - responses: - '204': - description: Submodel deleted successfully - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /description: - get: - tags: - - Description API - summary: Returns the self-describing information of a network resource (Description) - operationId: GetDescription - x-semanticIds: - - https://admin-shell.io/aas/API/Descriptor/GetDescription/3/0 - responses: - '200': - description: Requested Description - content: - application/json: - schema: - type: array - items: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/Description' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' \ No newline at end of file diff --git a/SubmodelRepositoryServiceSpecification/V3.0.yaml b/SubmodelRepositoryServiceSpecification/V3.0.yaml deleted file mode 100644 index 9582f39d..00000000 --- a/SubmodelRepositoryServiceSpecification/V3.0.yaml +++ /dev/null @@ -1,1485 +0,0 @@ -openapi: 3.0.3 -info: - title: DotAAS Part 2 | HTTP/REST | Submodel Repository Service Specification - description: "The entire Submodel Repository Service Specification as part of Details of the Asset Administration Shell Part 2 - Copyright: Industrial Digital Twin Association (IDTA) 2023" - contact: - name: Industrial Digital Twin Association (IDTA) - email: info@idtwin.org - license: - name: CC BY-SA 4.0 - url: https://creativecommons.org/licenses/by-sa/4.0/ - version: V3.0 - termsOfService: https://github.com/admin-shell-io/aas-specs -servers: -- url: '{protocol}://{host_name}:{port}/api/{version_prefix}' - variables: - protocol: - description: 'Allows access through http and https (recommended)' - enum: - - 'http' - - 'https' - default: 'https' - host_name: - default: admin-shell.io - description: 'Hostname of server hosting the api' - port: - enum: - - '80' - - '443' - default: '443' - description: '80 is default for http, 443 for https' - version_prefix: - enum: - - 'v3.0' - default: v3.0 -paths: - /submodels: - get: - tags: - - Submodel Repository API - summary: Returns all Submodels - operationId: GetAllSubmodels - x-semanticIds: - - https://admin-shell.io/aas/API/GetAllSubmodels/3/0 - - https://admin-shell.io/aas/API/GetAllSubmodelsBySemanticId/3/0 - - https://admin-shell.io/aas/API/GetAllSubmodelsByIdShort/3/0 - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/SemanticId' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/IdShort' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Limit' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Cursor' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Level' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Extent' - responses: - '200': - description: Requested Submodels - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/GetSubmodelsResult' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - post: - tags: - - Submodel Repository API - summary: Creates a new Submodel - operationId: PostSubmodel - x-semanticIds: - - https://admin-shell.io/aas/API/PostSubmodel/3/0 - requestBody: - description: Submodel object - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0#/components/schemas/Submodel' - required: true - responses: - '201': - description: Submodel created successfully - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0#/components/schemas/Submodel' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '409': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/conflict' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /submodels/$metadata: - get: - tags: - - Submodel Repository API - summary: Returns the metadata attributes of all Submodels - operationId: GetAllSubmodels-Metadata - x-semanticIds: - - https://admin-shell.io/aas/API/GetAllSubmodels/3/0 - - https://admin-shell.io/aas/API/GetAllSubmodelsBySemanticId/3/0 - - https://admin-shell.io/aas/API/GetAllSubmodelsByIdShort/3/0 - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/SemanticId' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/IdShort' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Limit' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Cursor' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Level' - responses: - '200': - description: Requested Submodels - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/GetSubmodelsMetadataResult' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /submodels/$value: - get: - tags: - - Submodel Repository API - summary: Returns all Submodels in their ValueOnly representation - operationId: GetAllSubmodels-ValueOnly - x-semanticIds: - - https://admin-shell.io/aas/API/GetAllSubmodels/3/0 - - https://admin-shell.io/aas/API/GetAllSubmodelsBySemanticId/3/0 - - https://admin-shell.io/aas/API/GetAllSubmodelsByIdShort/3/0 - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/SemanticId' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/IdShort' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Limit' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Cursor' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Level' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Extent' - responses: - '200': - description: Requested Submodels - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/GetSubmodelsValueResult' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /submodels/$reference: - get: - tags: - - Submodel Repository API - summary: Returns the References for all Submodels - operationId: GetAllSubmodels-Reference - x-semanticIds: - - https://admin-shell.io/aas/API/GetAllSubmodels/3/0 - - https://admin-shell.io/aas/API/GetAllSubmodelsBySemanticId/3/0 - - https://admin-shell.io/aas/API/GetAllSubmodelsByIdShort/3/0 - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/SemanticId' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/IdShort' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Limit' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Cursor' - #- $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Level' - - name: level - in: query - description: Determines the structural depth of the respective resource content - required: false - schema: - type: string - default: core - enum: - # - deep - - core # only 'core' is allowed for Content=Reference - responses: - '200': - description: References of the requested Submodels - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/GetReferencesResult' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /submodels/$path: - get: - tags: - - Submodel Repository API - summary: Returns all Submodels in the Path notation - operationId: GetAllSubmodels-Path - x-semanticIds: - - https://admin-shell.io/aas/API/GetAllSubmodels/3/0 - - https://admin-shell.io/aas/API/GetAllSubmodelsBySemanticId/3/0 - - https://admin-shell.io/aas/API/GetAllSubmodelsByIdShort/3/0 - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/SemanticId' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/IdShort' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Limit' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Cursor' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Level' - responses: - '200': - description: Requested Submodels - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/GetPathItemsResult' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /submodels/{submodelIdentifier}: - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/SubmodelIdentifier' - get: - tags: - - Submodel Repository API - summary: Returns a specific Submodel - operationId: GetSubmodelById - x-semanticIds: - - https://admin-shell.io/aas/API/GetSubmodelById/3/0 - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Level' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Extent' - responses: - '200': - description: Requested Submodel - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0#/components/schemas/Submodel' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - put: - tags: - - Submodel Repository API - summary: Updates an existing Submodel - operationId: PutSubmodelById - x-semanticIds: - - https://admin-shell.io/aas/API/PutSubmodelById/3/0 - parameters: - #- $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Level' - - name: level - in: query - description: Determines the structural depth of the respective resource content - required: false - schema: - type: string - default: deep - enum: - - deep # only 'deep' is allowed for PUT - #- core - requestBody: - description: Submodel object - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0#/components/schemas/Submodel' - required: true - responses: - '204': - description: Submodel updated successfully - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - patch: - tags: - - Submodel Repository API - summary: Updates an existing Submodel - operationId: PatchSubmodelById - x-semanticIds: - - https://admin-shell.io/aas/API/PatchSubmodelById/3/0 - parameters: - #- $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Level' - - name: level - in: query - description: Determines the structural depth of the respective resource content - required: false - schema: - type: string - default: core - enum: - #- deep - - core # only 'core' is allowed for PATCH - requestBody: - description: Submodel object - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0#/components/schemas/Submodel' - required: true - responses: - '204': - description: Submodel updated successfully - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - delete: - tags: - - Submodel Repository API - summary: Deletes a Submodel - operationId: DeleteSubmodelById - x-semanticIds: - - https://admin-shell.io/aas/API/DeleteSubmodelById/3/0 - responses: - '204': - description: Submodel deleted successfully - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /submodels/{submodelIdentifier}/$metadata: - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/SubmodelIdentifier' - get: - tags: - - Submodel Repository API - summary: Returns the metadata attributes of a specific Submodel - operationId: GetSubmodelById-Metadata - x-semanticIds: - - https://admin-shell.io/aas/API/GetSubmodelById/3/0 - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Level' - responses: - '200': - description: Requested Submodel in the metadata representation - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/SubmodelMetadata' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - patch: - tags: - - Submodel Repository API - summary: Updates the metadata attributes of an existing Submodel - operationId: PatchSubmodelById-Metadata - x-semanticIds: - - https://admin-shell.io/aas/API/PatchSubmodelById/3/0 - parameters: - #- $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Level' - - name: level - in: query - description: Determines the structural depth of the respective resource content - required: false - schema: - type: string - default: core - enum: - #- deep - - core # only 'core' is allowed for PATCH - requestBody: - description: The metadata attributes of the Submodel object - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/SubmodelMetadata' - required: true - responses: - '204': - description: Submodel updated successfully - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /submodels/{submodelIdentifier}/$value: - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/SubmodelIdentifier' - get: - tags: - - Submodel Repository API - summary: Returns a specific Submodel in the ValueOnly representation - operationId: GetSubmodelById-ValueOnly - x-semanticIds: - - https://admin-shell.io/aas/API/GetSubmodelById/3/0 - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Level' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Extent' - responses: - '200': - description: Requested Submodel - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/SubmodelValue' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - patch: - tags: - - Submodel Repository API - summary: Updates the values of an existing Submodel - operationId: PatchSubmodelById-ValueOnly - x-semanticIds: - - https://admin-shell.io/aas/API/PatchSubmodelById/3/0 - parameters: - #- $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Level' - - name: level - in: query - description: Determines the structural depth of the respective resource content - required: false - schema: - type: string - default: core - enum: - #- deep - - core # only 'core' is allowed for PATCH - requestBody: - description: Submodel object in its ValueOnly representation - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/SubmodelValue' - required: true - responses: - '204': - description: Submodel updated successfully - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /submodels/{submodelIdentifier}/$reference: - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/SubmodelIdentifier' - get: - tags: - - Submodel Repository API - summary: Returns the Reference of a specific Submodel - operationId: GetSubmodelById-Reference - x-semanticIds: - - https://admin-shell.io/aas/API/GetSubmodelById/3/0 - parameters: - #- $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Level' - - name: level - in: query - description: Determines the structural depth of the respective resource content - required: false - schema: - type: string - default: core - enum: - # - deep - - core # only 'core' is allowed for Content=Reference - responses: - '200': - description: Requested Submodel - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0#/components/schemas/Reference' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /submodels/{submodelIdentifier}/$path: - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/SubmodelIdentifier' - get: - tags: - - Submodel Repository API - summary: Returns a specific Submodel in the Path notation - operationId: GetSubmodelById-Path - x-semanticIds: - - https://admin-shell.io/aas/API/GetSubmodelById/3/0 - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Level' - responses: - '200': - description: Requested Submodel - content: - application/json: - schema: - type: array - items: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/PathItem' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /submodels/{submodelIdentifier}/submodel-elements: - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/SubmodelIdentifier' - get: - tags: - - Submodel Repository API - summary: Returns all submodel elements including their hierarchy - operationId: GetAllSubmodelElements - x-semanticIds: - - https://admin-shell.io/aas/API/GetAllSubmodelElements/3/0 - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Limit' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Cursor' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Level' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Extent' - responses: - '200': - description: List of found submodel elements - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/GetSubmodelElementsResult' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - description: Default error handling for unmentioned status codes - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/Result' - post: - tags: - - Submodel Repository API - summary: Creates a new submodel element - operationId: PostSubmodelElement_SubmodelRepo #TODO - x-semanticIds: - - https://admin-shell.io/aas/API/PostSubmodelElement/3/0 - requestBody: - description: Requested submodel element - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0#/components/schemas/SubmodelElement' - required: true - responses: - '201': - description: Submodel element created successfully - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0#/components/schemas/SubmodelElement' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '409': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/conflict' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /submodels/{submodelIdentifier}/submodel-elements/$metadata: - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/SubmodelIdentifier' - get: - tags: - - Submodel Repository API - summary: Returns the metadata attributes of all submodel elements including their hierarchy - operationId: GetAllSubmodelElements-Metadata_SubmodelRepo #TODO - x-semanticIds: - - https://admin-shell.io/aas/API/GetAllSubmodelElements/3/0 - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Limit' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Cursor' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Level' - responses: - '200': - description: List of found submodel elements - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/GetSubmodelElementsMetadataResult' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /submodels/{submodelIdentifier}/submodel-elements/$value: - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/SubmodelIdentifier' - get: - tags: - - Submodel Repository API - summary: Returns all submodel elements including their hierarchy in the ValueOnly representation - operationId: GetAllSubmodelElements-ValueOnly_SubmodelRepo # TODO - x-semanticIds: - - https://admin-shell.io/aas/API/GetAllSubmodelElements/3/0 - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Limit' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Cursor' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Level' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Extent' - responses: - '200': - description: List of found submodel elements - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/GetSubmodelElementsValueResult' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /submodels/{submodelIdentifier}/submodel-elements/$reference: - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/SubmodelIdentifier' - get: - tags: - - Submodel Repository API - summary: Returns the References of all submodel elements - operationId: GetAllSubmodelElements-Reference_SubmodelRepo # TODO - x-semanticIds: - - https://admin-shell.io/aas/API/GetAllSubmodelElements/3/0 - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Limit' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Cursor' - #- $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Level' - - name: level - in: query - description: Determines the structural depth of the respective resource content - required: false - schema: - type: string - default: core - enum: - # - deep - - core # only 'core' is allowed for Content=Reference - responses: - '200': - description: List of found submodel elements - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/GetReferencesResult' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /submodels/{submodelIdentifier}/submodel-elements/$path: - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/SubmodelIdentifier' - get: - tags: - - Submodel Repository API - summary: Returns all submodel elements including their hierarchy in the Path notation - operationId: GetAllSubmodelElements-Path_SubmodelRepo # TODO - x-semanticIds: - - https://admin-shell.io/aas/API/GetAllSubmodelElements/3/0 - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Limit' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Cursor' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Level' - responses: - '200': - description: List of found submodel elements in the Path notation - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/GetPathItemsResult' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /submodels/{submodelIdentifier}/submodel-elements/{idShortPath}: - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/SubmodelIdentifier' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/IdShortPath' - get: - tags: - - Submodel Repository API - summary: Returns a specific submodel element from the Submodel at a specified - path - operationId: GetSubmodelElementByPath_SubmodelRepo # TODO - x-semanticIds: - - https://admin-shell.io/aas/API/GetSubmodelElementByPath/3/0 - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Level' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Extent' - responses: - '200': - description: Requested submodel element - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0#/components/schemas/SubmodelElement' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - post: - tags: - - Submodel Repository API - summary: Creates a new submodel element at a specified path within submodel elements hierarchy - operationId: PostSubmodelElementByPath_SubmodelRepo # TODO - x-semanticIds: - - https://admin-shell.io/aas/API/PostSubmodelElementByPath/3/0 - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Level' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Extent' - requestBody: - description: Requested submodel element - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0#/components/schemas/SubmodelElement' - required: true - responses: - '201': - description: Submodel element created successfully - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0#/components/schemas/SubmodelElement' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '409': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/conflict' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - put: - tags: - - Submodel Repository API - summary: Updates an existing submodel element at a specified path within submodel elements hierarchy - operationId: PutSubmodelElementByPath_SubmodelRepo # TODO - x-semanticIds: - - https://admin-shell.io/aas/API/PutSubmodelElementByPath/3/0 - - https://admin-shell.io/aas/API/SetSubmodelElementValueByPath/3/0 - parameters: - #- $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Level' - - name: level - in: query - description: Determines the structural depth of the respective resource content - required: false - schema: - type: string - default: deep - enum: - - deep # only 'deep' is allowed for PUT - #- core - requestBody: - description: Requested submodel element - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0#/components/schemas/SubmodelElement' - required: true - responses: - '204': - description: Submodel element updated successfully - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - patch: - tags: - - Submodel Repository API - summary: Updates an existing SubmodelElement - operationId: PatchSubmodelElementByPath_SubmodelRepo # TODO - x-semanticIds: - - https://admin-shell.io/aas/API/PatchSubmodelById/3/0 - parameters: - #- $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Level' - - name: level - in: query - description: Determines the structural depth of the respective resource content - required: false - schema: - type: string - default: core - enum: - #- deep - - core # only 'core' is allowed for PATCH - requestBody: - description: SubmodelElement object - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0#/components/schemas/SubmodelElement' - required: true - responses: - '204': - description: SubmodelElement updated successfully - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - delete: - tags: - - Submodel Repository API - summary: Deletes a submodel element at a specified path within the submodel elements hierarchy - operationId: DeleteSubmodelElementByPath_SubmodelRepo # TODO - x-semanticIds: - - https://admin-shell.io/aas/API/DeleteSubmodelElementByPath/3/0 - responses: - '204': - description: Submodel element deleted successfully - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /submodels/{submodelIdentifier}/submodel-elements/{idShortPath}/$metadata: - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/SubmodelIdentifier' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/IdShortPath' - get: - tags: - - Submodel Repository API - summary: Returns the matadata attributes of a specific submodel element from the Submodel at a specified - path - operationId: GetSubmodelElementByPath-Metadata_SubmodelRepo # TODO - x-semanticIds: - - https://admin-shell.io/aas/API/GetSubmodelElementByPath/3/0 - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Level' - responses: - '200': - description: Metadata attributes of the requested submodel element - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/SubmodelElementMetadata' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - patch: - tags: - - Submodel Repository API - summary: Updates the metadata attributes an existing SubmodelElement - operationId: PatchSubmodelElementByPath-Metadata_SubmodelRepo # TODO - x-semanticIds: - - https://admin-shell.io/aas/API/PatchSubmodelElementByPath/3/0 - parameters: - #- $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Level' - - name: level - in: query - description: Determines the structural depth of the respective resource content - required: false - schema: - type: string - default: core - enum: - #- deep - - core # only 'core' is allowed for PATCH - requestBody: - description: Metadata attributes of the SubmodelElement - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/SubmodelElementMetadata' - required: true - responses: - '204': - description: SubmodelElement updated successfully - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /submodels/{submodelIdentifier}/submodel-elements/{idShortPath}/$value: - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/SubmodelIdentifier' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/IdShortPath' - get: - tags: - - Submodel Repository API - summary: Returns a specific submodel element from the Submodel at a specified - path in the ValueOnly representation - operationId: GetSubmodelElementByPath-ValueOnly_SubmodelRepo # TODO - x-semanticIds: - - https://admin-shell.io/aas/API/GetSubmodelElementByPath/3/0 - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Level' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Extent' - responses: - '200': - description: Requested submodel element - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/SubmodelElementValue' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - patch: - tags: - - Submodel Repository API - summary: Updates the value of an existing SubmodelElement - operationId: PatchSubmodelElementByPath-ValueOnly_SubmodelRepo # TODO - x-semanticIds: - - https://admin-shell.io/aas/API/PatchSubmodelElementByPath/3/0 - parameters: - #- $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Level' - - name: level - in: query - description: Determines the structural depth of the respective resource content - required: false - schema: - type: string - default: core - enum: - #- deep - - core # only 'core' is allowed for PATCH - requestBody: - description: The SubmodelElement in its ValueOnly representation - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/SubmodelElementValue' - required: true - responses: - '204': - description: Submodel updated successfully - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /submodels/{submodelIdentifier}/submodel-elements/{idShortPath}/$reference: - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/SubmodelIdentifier' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/IdShortPath' - get: - tags: - - Submodel Repository API - summary: Returns the Referene of a specific submodel element from the Submodel at a specified - path - operationId: GetSubmodelElementByPath-Reference_SubmodelRepo # TODO - x-semanticIds: - - https://admin-shell.io/aas/API/GetSubmodelElementByPath/3/0 - parameters: - #- $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Level' - - name: level - in: query - description: Determines the structural depth of the respective resource content - required: false - schema: - type: string - default: core - enum: - # - deep - - core # only 'core' is allowed for Content=Reference - responses: - '200': - description: Requested submodel element - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0#/components/schemas/Reference' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /submodels/{submodelIdentifier}/submodel-elements/{idShortPath}/$path: - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/SubmodelIdentifier' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/IdShortPath' - get: - tags: - - Submodel Repository API - summary: Returns a specific submodel element from the Submodel at a specified - path in the Path notation - operationId: GetSubmodelElementByPath-Path_SubmodelRepo # TODO - x-semanticIds: - - https://admin-shell.io/aas/API/GetSubmodelElementByPath/3/0 - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Level' - responses: - '200': - description: Requested submodel element - content: - application/json: - schema: - type: array - items: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/PathItem' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /submodels/{submodelIdentifier}/submodel-elements/{idShortPath}/attachment: - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/SubmodelIdentifier' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/IdShortPath' - get: - tags: - - Submodel Repository API - summary: Downloads file content from a specific submodel element from the Submodel at a specified path - operationId: GetFileByPath_SubmodelRepo # TODO - x-semanticIds: - - https://admin-shell.io/aas/API/GetFileByPath/3/0 - responses: - '200': - description: Requested file - headers: - Content-Disposition: - schema: - type: string - description: In order to physically download the file usually set to attachment with a filename - example: 'attachment; filename="filename.jpg"' - content: - application/octet-stream: - schema: - type: string - format: binary - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '405': - description: Method not allowed - Download only valid for File submodel element - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/Result' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - put: - tags: - - Submodel Repository API - summary: Uploads file content to an existing submodel element at a specified path within submodel elements hierarchy - operationId: PutFileByPath_SubmodelRepo # TODO - x-semanticIds: - - https://admin-shell.io/aas/API/PutFileByPath/3/0 - requestBody: - description: File to upload - content: - multipart/form-data: - schema: - type: object - properties: - fileName: - type: string - file: - type: string - format: binary - encoding: - file: - contentType: application/octet-stream - required: true - responses: - '204': - description: Submodel element updated successfully - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '405': - description: Method not allowed - Upload only valid for File submodel element - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/Result' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - delete: - tags: - - Submodel Repository API - summary: Deletes file content of an existing submodel element at a specified path within submodel elements hierarchy - operationId: DeleteFileByPath_SubmodelRepo # TODO - x-semanticIds: - - https://admin-shell.io/aas/API/DeleteFileByPath/3/0 - responses: - '200': - description: Submodel element updated successfully - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /submodels/{submodelIdentifier}/submodel-elements/{idShortPath}/invoke: - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/SubmodelIdentifier' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/IdShortPath' - post: - tags: - - Submodel Repository API - summary: Synchronously or asynchronously invokes an Operation at a specified path - operationId: InvokeOperation_SubmodelRepo # TODO - x-semanticIds: - - https://admin-shell.io/aas/API/InvokeOperationSync/3/0 - - https://admin-shell.io/aas/API/InvokeOperationAsync/3/0 - parameters: - - name: async - in: query - description: Determines whether an operation invocation is performed asynchronously or synchronously - schema: - type: boolean - default: false - requestBody: - description: Operation request object - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/OperationRequest' - required: true - responses: - '200': - description: Operation result object - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/OperationResult' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '405': - description: Method not allowed - Invoke only valid for Operation submodel element - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/Result' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /submodels/{submodelIdentifier}/submodel-elements/{idShortPath}/invoke/$value: - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/AssetAdministrationShellIdentifier' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/SubmodelIdentifier' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/IdShortPath' - post: - tags: - - Submodel Repository API - summary: Synchronously or asynchronously invokes an Operation at a specified path - operationId: InvokeOperation-ValueOnly_SubmodelRepo # TODO - x-semanticIds: - - https://admin-shell.io/aas/API/InvokeOperationSync/3/0 - - https://admin-shell.io/aas/API/InvokeOperationAsync/3/0 - parameters: - - name: async - in: query - description: Determines whether an operation invocation is performed asynchronously or synchronously - schema: - type: boolean - default: false - requestBody: - description: Operation request object - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/OperationRequestValueOnly' - required: true - responses: - '200': - description: Operation result object - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/OperationResultValueOnly' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /submodels/{submodelIdentifier}/submodel-elements/{idShortPath}/operation-results/{handleId}: - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/SubmodelIdentifier' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/IdShortPath' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/HandleId' - get: - tags: - - Submodel Repository API - summary: Returns the Operation result of an asynchronous invoked Operation - operationId: GetOperationAsyncResult_SubmodelRepo # TODO - x-semanticIds: - - https://admin-shell.io/aas/API/GetOperationAsyncResult/3/0 - responses: - '200': - description: Operation result object - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/OperationResult' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /submodels/{submodelIdentifier}/submodel-elements/{idShortPath}/operation-results/{handleId}/$value: - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/SubmodelIdentifier' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/IdShortPath' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/HandleId' - get: - tags: - - Submodel Repository API - summary: Returns the Operation result of an asynchronous invoked Operation - operationId: GetOperationAsyncResult-ValueOnly_SubmodelRepo # TODO - x-semanticIds: - - https://admin-shell.io/aas/API/GetOperationAsyncResult/3/0 - responses: - '200': - description: Value of the operation result object - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/OperationResultValueOnly' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /serialization: - get: - tags: - - Serialization API - summary: Returns an appropriate serialization based on the specified format (see SerializationFormat) - operationId: GenerateSerializationByIds - x-semanticIds: - - https://admin-shell.io/aas/API/GenerateSerializationByIds/3/0 - parameters: - - name: aasIds - in: query - description: The Asset Administration Shells' unique ids (UTF8-BASE64-URL-encoded) - style: form - explode: true - schema: - type: array - items: - type: string - - name: submodelIds - in: query - description: The Submodels' unique ids (UTF8-BASE64-URL-encoded) - style: form - explode: true - schema: - type: array - items: - type: string - - name: includeConceptDescriptions - in: query - description: Include Concept Descriptions? - style: form - explode: true - schema: - type: boolean - default: true - responses: - '200': - description: Requested serialization based on SerializationFormat - content: - application/asset-administration-shell-package+xml: - schema: - description: AASX package - type: string - format: binary - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0#/components/schemas/Environment' - application/xml: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0#/components/schemas/Environment' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /description: - get: - tags: - - Description API - summary: Returns the self-describing information of a network resource (ServiceDescription) - operationId: GetDescription - x-semanticIds: - - https://admin-shell.io/aas/API/Descriptor/GetDescription/3/0 - responses: - '200': - description: Requested Description - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/ServiceDescription' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' \ No newline at end of file diff --git a/SubmodelServiceSpecification/V3.0-MinimalProfile.yaml b/SubmodelServiceSpecification/V3.0-MinimalProfile.yaml deleted file mode 100644 index 839f7c8a..00000000 --- a/SubmodelServiceSpecification/V3.0-MinimalProfile.yaml +++ /dev/null @@ -1,73 +0,0 @@ -openapi: 3.0.3 -info: - title: DotAAS Part 2 | HTTP/REST | Submodel Service Specification - Minimal Profile - description: The Minimal Profile of the Submodel Service Specification as part of Details of the Asset Administration Shell Part 2 - contact: - name: Constantin Ziesche, Andreas Orzelski, Florian Krebs, Bastian Rössl, Manuel Sauer, Jens Vialkowitsch, Michael Hoffmeister, Torben Miny, Sebastian Bader, Marko Ristin, Nico Braunisch - version: V3.0-MinimalProfile - termsOfService: https://github.com/admin-shell-io/aas-specs -servers: -- url: '{protocol}://{host_name}:{port}/api/{version_prefix}' - variables: - protocol: - description: 'Allows access through http and https (recommended)' - enum: - - 'http' - - 'https' - default: 'https' - host_name: - default: admin-shell.io - description: 'Hostname of server hosting the api' - port: - enum: - - '80' - - '443' - default: '443' - description: '80 is default for http, 443 for https' - version_prefix: - enum: - - 'v3.0' - default: v3.0 -paths: - /submodel: - get: - tags: - - Submodel API - summary: Returns the Submodel - operationId: GetSubmodel - x-semanticIds: - - https://admin-shell.io/aas/API/GetSubmodel/3/0 - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Extent' - responses: - '200': - description: Requested Submodel - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0RC02#/components/schemas/Submodel' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /description: - get: - tags: - - Description API - summary: Returns the self-describing information of a network resource (ServiceDescription) - operationId: GetDescription - x-semanticIds: - - https://admin-shell.io/aas/API/Descriptor/GetDescription/3/0 - responses: - '200': - description: Requested Description - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/ServiceDescription' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' \ No newline at end of file diff --git a/SubmodelServiceSpecification/V3.0-ValueProfile.yaml b/SubmodelServiceSpecification/V3.0-ValueProfile.yaml deleted file mode 100644 index 5e200141..00000000 --- a/SubmodelServiceSpecification/V3.0-ValueProfile.yaml +++ /dev/null @@ -1,145 +0,0 @@ -openapi: 3.0.3 -info: - title: DotAAS Part 2 | HTTP/REST | Submodel Service Specification - Value Profile - description: The Value Profile of the Submodel Service Specification as part of Details of the Asset Administration Shell Part 2 - contact: - name: Constantin Ziesche, Andreas Orzelski, Florian Krebs, Bastian Rössl, Manuel Sauer, Jens Vialkowitsch, Michael Hoffmeister, Torben Miny, Sebastian Bader, Marko Ristin, Nico Braunisch - version: V3.0-ValueProfile - termsOfService: https://github.com/admin-shell-io/aas-specs -servers: -- url: '{protocol}://{host_name}:{port}/api/{version_prefix}' - variables: - protocol: - description: 'Allows access through http and https (recommended)' - enum: - - 'http' - - 'https' - default: 'https' - host_name: - default: admin-shell.io - description: 'Hostname of server hosting the api' - port: - enum: - - '80' - - '443' - default: '443' - description: '80 is default for http, 443 for https' - version_prefix: - enum: - - 'v3.0' - default: v3.0 -paths: - /submodel: - get: - tags: - - Submodel API - summary: Returns the Submodel - operationId: GetSubmodel - x-semanticIds: - - https://admin-shell.io/aas/API/GetSubmodel/3/0 - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Extent' - responses: - '200': - description: Requested Submodel - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0RC02#/components/schemas/Submodel' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /submodel/$value: - get: - tags: - - Submodel API - summary: Returns the Submodel in the ValueOnly representation - operationId: GetSubmodelValueOnly - x-semanticIds: - - https://admin-shell.io/aas/API/GetSubmodelById/3/0 - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Extent' - responses: - '200': - description: ValueOnly representation of the Submodel - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/SubmodelValue' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /submodel/submodel-elements/{idShortPath}/invoke: - post: - tags: - - Submodel API - summary: Synchronously or asynchronously invokes an Operation at a specified path - operationId: InvokeOperation - x-semanticIds: - - https://admin-shell.io/aas/API/InvokeOperationSync/3/0 - parameters: - - name: idShortPath - in: path - description: IdShort path to the submodel element (dot-separated), in this case an operation - required: true - style: simple - explode: false - schema: - type: string - requestBody: - description: Operation request object - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/OperationRequest' - required: true - responses: - '200': - description: Operation result object - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/OperationResult' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '405': - description: Method not allowed - Invoke only valid for Operation submodel element - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/Result' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /description: - get: - tags: - - Description API - summary: Returns the self-describing information of a network resource (ServiceDescription) - operationId: GetDescription - x-semanticIds: - - https://admin-shell.io/aas/API/Descriptor/GetDescription/3/0 - responses: - '200': - description: Requested Description - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/ServiceDescription' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' \ No newline at end of file diff --git a/SubmodelServiceSpecification/V3.0.yaml b/SubmodelServiceSpecification/V3.0.yaml deleted file mode 100644 index f2fb9165..00000000 --- a/SubmodelServiceSpecification/V3.0.yaml +++ /dev/null @@ -1,1220 +0,0 @@ -openapi: 3.0.3 -info: - title: DotAAS Part 2 | HTTP/REST | Submodel Service Specification - description: "The entire Submodel Service Specification as part of Details of the Asset Administration Shell Part 2 - Copyright: Industrial Digital Twin Association (IDTA) 2023" - contact: - name: Industrial Digital Twin Association (IDTA) - email: info@idtwin.org - license: - name: CC BY-SA 4.0 - url: https://creativecommons.org/licenses/by-sa/4.0/ - version: V3.0 - termsOfService: https://github.com/admin-shell-io/aas-specs -servers: -- url: '{protocol}://{host_name}:{port}/api/{version_prefix}' - variables: - protocol: - description: 'Allows access through http and https (recommended)' - enum: - - 'http' - - 'https' - default: 'https' - host_name: - default: admin-shell.io - description: 'Hostname of server hosting the api' - port: - enum: - - '80' - - '443' - default: '443' - description: '80 is default for http, 443 for https' - version_prefix: - enum: - - 'v3.0' - default: v3.0 -paths: - /submodel: - get: - tags: - - Submodel API - summary: Returns the Submodel - operationId: GetSubmodel - x-semanticIds: - - https://admin-shell.io/aas/API/GetSubmodel/3/0 - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Level' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Extent' - responses: - '200': - description: Requested Submodel - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0#/components/schemas/Submodel' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - put: - tags: - - Submodel API - summary: Updates the Submodel - operationId: PutSubmodel - x-semanticIds: - - https://admin-shell.io/aas/API/PutSubmodel/3/0 - parameters: - - name: level - in: query - description: Determines the structural depth of the respective resource content - required: false - schema: - type: string - default: deep - enum: - - deep # only 'deep' is allowed for PUT - #- core - requestBody: - description: Submodel object - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0#/components/schemas/Submodel' - required: true - responses: - '204': - description: Submodel updated successfully - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - patch: - tags: - - Submodel API - summary: Updates the Submodel - operationId: PatchSubmodel - x-semanticIds: - - https://admin-shell.io/aas/API/PatchSubmodel/3/0 - parameters: - #- $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Level' - - name: level - in: query - description: Determines the structural depth of the respective resource content - required: false - schema: - type: string - default: core - enum: - #- deep - - core # only 'core' is allowed for PATCH - requestBody: - description: Submodel object - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0#/components/schemas/Submodel' - required: true - responses: - '204': - description: Submodel updated successfully - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - - /submodel/$metadata: - get: - tags: - - Submodel API - summary: Returns the metadata attributes of a specific Submodel - operationId: GetSubmodel-Metadata - x-semanticIds: - - https://admin-shell.io/aas/API/GetSubmodel/3/0 - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Level' - responses: - '200': - description: Requested Submodel in the metadata representation - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/SubmodelMetadata' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - patch: - tags: - - Submodel API - summary: Updates the metadata attributes of the Submodel - operationId: PatchSubmodel-Metadata - x-semanticIds: - - https://admin-shell.io/aas/API/PatchSubmodel/3/0 - parameters: - #- $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Level' - - name: level - in: query - description: Determines the structural depth of the respective resource content - required: false - schema: - type: string - default: core - enum: - #- deep - - core # only 'core' is allowed for PATCH - requestBody: - description: The metadata attributes of the Submodel object - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/SubmodelMetadata' - required: true - responses: - '204': - description: Submodel updated successfully - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /submodel/$value: - get: - tags: - - Submodel API - summary: Returns the Submodel in the ValueOnly representation - operationId: GetSubmodel-ValueOnly - x-semanticIds: - - https://admin-shell.io/aas/API/GetSubmodelById/3/0 - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Level' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Extent' - responses: - '200': - description: ValueOnly representation of the Submodel - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/SubmodelValue' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - patch: - tags: - - Submodel API - summary: Updates the values of the Submodel - operationId: PatchSubmodel-ValueOnly - x-semanticIds: - - https://admin-shell.io/aas/API/PatchSubmodel/3/0 - parameters: - #- $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Level' - - name: level - in: query - description: Determines the structural depth of the respective resource content - required: false - schema: - type: string - default: core - enum: - #- deep - - core # only 'core' is allowed for PATCH - requestBody: - description: Submodel object in its ValueOnly representation - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/SubmodelValue' - required: true - responses: - '204': - description: Submodel updated successfully - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /submodel/$reference: - get: - tags: - - Submodel API - summary: Returns the Reference of the Submodel - operationId: GetSubmodel-Reference - x-semanticIds: - - https://admin-shell.io/aas/API/GetSubmodel/3/0 - parameters: - #- $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Level' - - name: level - in: query - description: Determines the structural depth of the respective resource content - required: false - schema: - type: string - default: core - enum: - # - deep - - core # only 'core' is allowed for Content=Reference - responses: - '200': - description: Requested Reference - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0#/components/schemas/Reference' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /submodel/$path: - get: - tags: - - Submodel API - summary: Returns the Submodel in the Path notation - operationId: GetSubmodel-Path - x-semanticIds: - - https://admin-shell.io/aas/API/GetSubmodelById/3/0 - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Level' - responses: - '200': - description: Submodel in Path notation - content: - application/json: - schema: - type: array - items: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/PathItem' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /submodel/submodel-elements: - get: - tags: - - Submodel API - summary: Returns all submodel elements including their hierarchy - operationId: GetAllSubmodelElements - x-semanticIds: - - https://admin-shell.io/aas/API/GetAllSubmodelElements/3/0 - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Limit' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Cursor' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Level' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Extent' - responses: - '200': - description: List of found submodel elements - content: - application/json: - schema: - type: array - items: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/GetSubmodelElementsResult' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - post: - tags: - - Submodel API - summary: Creates a new submodel element - operationId: PostSubmodelElement - x-semanticIds: - - https://admin-shell.io/aas/API/PostSubmodelElement/3/0 - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Level' - requestBody: - description: Requested submodel element - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0#/components/schemas/SubmodelElement' - required: true - responses: - '201': - description: Submodel element created successfully - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0#/components/schemas/SubmodelElement' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '409': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/conflict' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /submodel/submodel-elements/$metadata: - get: - tags: - - Submodel API - summary: Returns the metadata attributes of all submodel elements including their hierarchy - operationId: GetAllSubmodelElements-Metadata - x-semanticIds: - - https://admin-shell.io/aas/API/GetAllSubmodelElements/3/0 - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Limit' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Cursor' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Level' - responses: - '200': - description: List of found submodel elements - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/GetSubmodelElementsMetadataResult' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /submodel/submodel-elements/$value: - get: - tags: - - Submodel API - summary: Returns all submodel elements including their hierarchy in the ValueOnly representation - operationId: GetAllSubmodelElements-ValueOnly - x-semanticIds: - - https://admin-shell.io/aas/API/GetAllSubmodelElements/3/0 - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Limit' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Cursor' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Level' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Extent' - responses: - '200': - description: List of found submodel elements - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/GetSubmodelElementsValueResult' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /submodel/submodel-elements/$reference: - get: - tags: - - Submodel API - summary: Returns the References of all submodel elements - operationId: GetAllSubmodelElements-Reference - x-semanticIds: - - https://admin-shell.io/aas/API/GetAllSubmodelElements/3/0 - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Limit' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Cursor' - - name: level - in: query - description: Determines the structural depth of the respective resource content - required: false - schema: - type: string - default: core - enum: - # - deep - - core # only 'core' is allowed for Content=Reference - responses: - '200': - description: List of found submodel elements - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/GetReferencesResult' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /submodel/submodel-elements/$path: - get: - tags: - - Submodel API - summary: Returns all submodel elements including their hierarchy in the Path notation - operationId: GetAllSubmodelElements-Path - x-semanticIds: - - https://admin-shell.io/aas/API/GetAllSubmodelElements/3/0 - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Limit' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Cursor' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Level' - responses: - '200': - description: List of found submodel elements in the Path notation - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/GetPathItemsResult' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /submodel/submodel-elements/{idShortPath}: - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/IdShortPath' - get: - tags: - - Submodel API - summary: Returns a specific submodel element from the Submodel at a specified - path - operationId: GetSubmodelElementByPath - x-semanticIds: - - https://admin-shell.io/aas/API/GetSubmodelElementByPath/3/0 - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Limit' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Cursor' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Level' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Extent' - responses: - '200': - description: Requested submodel element - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/GetSubmodelElementsResult' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - post: - tags: - - Submodel API - summary: Creates a new submodel element at a specified path within submodel elements hierarchy - operationId: PostSubmodelElementByPath - x-semanticIds: - - https://admin-shell.io/aas/API/PostSubmodelElementByPath/3/0 - requestBody: - description: Requested submodel element - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0#/components/schemas/SubmodelElement' - required: true - responses: - '201': - description: Submodel element created successfully - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0#/components/schemas/SubmodelElement' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '409': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/conflict' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - put: - tags: - - Submodel API - summary: Updates an existing submodel element at a specified path within submodel elements hierarchy - operationId: PutSubmodelElementByPath - x-semanticIds: - - https://admin-shell.io/aas/API/PutSubmodelElementByPath/3/0 - - https://admin-shell.io/aas/API/SetSubmodelElementValueByPath/3/0 - parameters: - #- $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Level' - - name: level - in: query - description: Determines the structural depth of the respective resource content - required: false - schema: - type: string - default: deep - enum: - - deep # only 'deep' is allowed for PUT - #- core - requestBody: - description: Requested submodel element - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0#/components/schemas/SubmodelElement' - required: true - responses: - '204': - description: Submodel element updated successfully - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - patch: - tags: - - Submodel API - summary: Updates an existing SubmodelElement - operationId: PatchSubmodelElementByPath - x-semanticIds: - - https://admin-shell.io/aas/API/PatchSubmodelById/3/0 - parameters: - #- $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Level' - - name: level - in: query - description: Determines the structural depth of the respective resource content - required: false - schema: - type: string - default: core - enum: - #- deep - - core # only 'core' is allowed for PATCH - requestBody: - description: SubmodelElement object - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0#/components/schemas/SubmodelElement' - required: true - responses: - '204': - description: SubmodelElement updated successfully - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - delete: - tags: - - Submodel API - summary: Deletes a submodel element at a specified path within the submodel elements hierarchy - operationId: DeleteSubmodelElementByPath - x-semanticIds: - - https://admin-shell.io/aas/API/DeleteSubmodelElementByPath/3/0 - responses: - '204': - description: Submodel element deleted successfully - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /submodel/submodel-elements/{idShortPath}/$metadata: - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/IdShortPath' - get: - tags: - - Submodel API - summary: Returns the matadata attributes of a specific submodel element from the Submodel at a specified - path - operationId: GetSubmodelElementByPath-Metadata - x-semanticIds: - - https://admin-shell.io/aas/API/GetSubmodelElementByPath/3/0 - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Level' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Limit' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Cursor' - responses: - '200': - description: Metadata attributes of the requested submodel element - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/GetSubmodelElementsMetadataResult' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - patch: - tags: - - Submodel API - summary: Updates the metadata attributes an existing SubmodelElement - operationId: PatchSubmodelElementByPath-Metadata - x-semanticIds: - - https://admin-shell.io/aas/API/PatchSubmodelElementByPath/3/0 - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Limit' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Cursor' - #- $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Level' - - name: level - in: query - description: Determines the structural depth of the respective resource content - required: false - schema: - type: string - default: core - enum: - #- deep - - core # only 'core' is allowed for PATCH - requestBody: - description: Metadata attributes of the SubmodelElement - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/GetSubmodelElementsMetadataResult' - required: true - responses: - '204': - description: SubmodelElement updated successfully - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /submodel/submodel-elements/{idShortPath}/$value: - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/IdShortPath' - get: - tags: - - Submodel API - summary: Returns a specific submodel element from the Submodel at a specified - path in the ValueOnly representation - operationId: GetSubmodelElementByPath-ValueOnly - x-semanticIds: - - https://admin-shell.io/aas/API/GetSubmodelElementByPath/3/0 - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Limit' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Cursor' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Level' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Extent' - responses: - '200': - description: Requested submodel element - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/GetSubmodelElementsValueResult' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - patch: - tags: - - Submodel API - summary: Updates the value of an existing SubmodelElement - operationId: PatchSubmodelElementByPath-ValueOnly - x-semanticIds: - - https://admin-shell.io/aas/API/PatchSubmodelElementByPath/3/0 - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Limit' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Cursor' - #- $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Level' - - name: level - in: query - description: Determines the structural depth of the respective resource content - required: false - schema: - type: string - default: core - enum: - #- deep - - core # only 'core' is allowed for PATCH - requestBody: - description: The SubmodelElement in its ValueOnly representation - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/GetSubmodelElementsValueResult' - required: true - responses: - '204': - description: Submodel updated successfully - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /submodel/submodel-elements/{idShortPath}/$reference: - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/IdShortPath' - get: - tags: - - Submodel API - summary: Returns the Referene of a specific submodel element from the Submodel at a specified - path - operationId: GetSubmodelElementByPath-Reference - x-semanticIds: - - https://admin-shell.io/aas/API/GetSubmodelElementByPath/3/0 - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Limit' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Cursor' - #- $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Level' - - name: level - in: query - description: Determines the structural depth of the respective resource content - required: false - schema: - type: string - default: core - enum: - # - deep - - core # only 'core' is allowed for Content=Reference - responses: - '200': - description: Requested submodel element - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/GetReferencesResult' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /submodel/submodel-elements/{idShortPath}/$path: - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/IdShortPath' - get: - tags: - - Submodel API - summary: Returns a specific submodel element from the Submodel at a specified - path in the Path notation - operationId: GetSubmodelElementByPath-Path - x-semanticIds: - - https://admin-shell.io/aas/API/GetSubmodelElementByPath/3/0 - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Limit' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Cursor' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Level' - responses: - '200': - description: Requested submodel element - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/GetPathItemsResult' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /submodel/submodel-elements/{idShortPath}/attachment: - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/IdShortPath' - get: - tags: - - Submodel API - summary: Downloads file content from a specific submodel element from the Submodel at a specified path - operationId: GetFileByPath - x-semanticIds: - - https://admin-shell.io/aas/API/GetFileByPath/3/0 - responses: - '200': - description: Requested file - headers: - Content-Disposition: - schema: - type: string - description: In order to physically download the file usually set to attachment with a filename - example: 'attachment; filename="filename.jpg"' - content: - application/octet-stream: - schema: - type: string - format: binary - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '405': - description: Method not allowed - Download only valid for File submodel element - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/Result' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - put: - tags: - - Submodel API - summary: Uploads file content to an existing submodel element at a specified path within submodel elements hierarchy - operationId: PutFileByPath - x-semanticIds: - - https://admin-shell.io/aas/API/PutFileByPath/3/0 - requestBody: - description: File to upload - content: - multipart/form-data: - schema: - type: object - properties: - fileName: - type: string - file: - type: string - format: binary - encoding: - file: - contentType: application/octet-stream - required: true - responses: - '204': - description: Submodel element updated successfully - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '405': - description: Method not allowed - Upload only valid for File submodel element - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/Result' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - delete: - tags: - - Submodel API - summary: Deletes file content of an existing submodel element at a specified path within submodel elements hierarchy - operationId: DeleteFileByPath_SubmodelRepo # TODO - x-semanticIds: - - https://admin-shell.io/aas/API/DeleteFileByPath/3/0 - responses: - '200': - description: Submodel element updated successfully - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /submodel/submodel-elements/{idShortPath}/invoke: - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/IdShortPath' - post: - tags: - - Submodel API - summary: Synchronously or asynchronously invokes an Operation at a specified path - operationId: InvokeOperation - x-semanticIds: - - https://admin-shell.io/aas/API/InvokeOperationSync/3/0 - - https://admin-shell.io/aas/API/InvokeOperationAsync/3/0 - parameters: - - name: async - in: query - description: Determines whether an operation invocation is performed asynchronously or synchronously - schema: - type: boolean - default: false - requestBody: - description: Operation request object - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/OperationRequest' - required: true - responses: - '200': - description: Operation result object - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/OperationResult' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '405': - description: Method not allowed - Invoke only valid for Operation submodel element - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/Result' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /submodel/submodel-elements/{idShortPath}/invoke/$value: - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/IdShortPath' - post: - tags: - - Submodel API - summary: Synchronously or asynchronously invokes an Operation at a specified path - operationId: InvokeOperation-ValueOnly - x-semanticIds: - - https://admin-shell.io/aas/API/InvokeOperationSync/3/0 - - https://admin-shell.io/aas/API/InvokeOperationAsync/3/0 - parameters: - - name: async - in: query - description: Determines whether an operation invocation is performed asynchronously or synchronously - schema: - type: boolean - default: false - requestBody: - description: Operation request object - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/OperationRequestValueOnly' - required: true - responses: - '200': - description: Operation result object - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/OperationResultValueOnly' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '405': - description: Method not allowed - Invoke only valid for Operation submodel element - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/Result' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /submodel/submodel-elements/{idShortPath}/operation-results/{handleId}: - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/IdShortPath' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/HandleId' - get: - tags: - - Submodel API - summary: Returns the Operation result of an asynchronous invoked Operation - operationId: GetOperationAsyncResult - x-semanticIds: - - https://admin-shell.io/aas/API/GetOperationAsyncResult/3/0 - responses: - '200': - description: Operation result object - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/OperationResult' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /submodel/submodel-elements/{idShortPath}/operation-results/{handleId}/$value: - parameters: - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/IdShortPath' - - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/HandleId' - get: - tags: - - Submodel API - summary: Returns the value of the Operation result of an asynchronous invoked Operation - operationId: GetOperationAsyncResult-ValueOnly - x-semanticIds: - - https://admin-shell.io/aas/API/GetOperationAsyncResult/3/0 - responses: - '200': - description: Operation result object - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/OperationResultValueOnly' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /serialization: - get: - tags: - - Serialization API - summary: Returns an appropriate serialization based on the specified format (see SerializationFormat) - operationId: GenerateSerializationByIds - x-semanticIds: - - https://admin-shell.io/aas/API/GenerateSerializationByIds/3/0 - parameters: - - name: aasIds - in: query - description: The Asset Administration Shells' unique ids (UTF8-BASE64-URL-encoded) - style: form - explode: true - schema: - type: array - items: - type: string - - name: submodelIds - in: query - description: The Submodels' unique ids (UTF8-BASE64-URL-encoded) - style: form - explode: true - schema: - type: array - items: - type: string - - name: includeConceptDescriptions - in: query - description: Include Concept Descriptions? - style: form - explode: true - schema: - type: boolean - default: true - responses: - '200': - description: Requested serialization based on SerializationFormat - content: - application/asset-administration-shell-package+xml: - schema: - description: AASX package - type: string - format: binary - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0#/components/schemas/Environment' - application/xml: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0#/components/schemas/Environment' - '400': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' - '404': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found' - '500': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error' - default: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default' - /description: - get: - tags: - - Description API - summary: Returns the self-describing information of a network resource (ServiceDescription) - operationId: GetDescription - x-semanticIds: - - https://admin-shell.io/aas/API/Descriptor/GetDescription/3/0 - responses: - '200': - description: Requested Description - content: - application/json: - schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/ServiceDescription' - '403': - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden' \ No newline at end of file