diff --git a/AssetAdministrationShellRepositoryServiceSpecification/V3.2_SSP-004.yaml b/AssetAdministrationShellRepositoryServiceSpecification/V3.2_SSP-004.yaml new file mode 100644 index 00000000..3e874aca --- /dev/null +++ b/AssetAdministrationShellRepositoryServiceSpecification/V3.2_SSP-004.yaml @@ -0,0 +1,485 @@ +openapi: 3.0.3 +info: + title: DotAAS Part 2 | HTTP/REST | Asset Administration Shell Repository Service Specification + description: >- + The Identifiable Profile of the Asset Administration Shell Repository Service Specification as part of the [Specification of the Asset Administration Shell: Part 2](https://industrialdigitaltwin.org/en/content-hub/aasspecifications). + + Copyright: Industrial Digital Twin Association (IDTA) 2026 + 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.2.0_SSP-004 + x-profile-identifier: https://admin-shell.io/aas/API/3/2/AssetAdministrationShellRepositoryServiceSpecification/SSP-004 +servers: +- url: 'https://admin-shell.io/api/v3/' +- url: 'https://example.com/' +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/2 + parameters: + - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.2.0#/components/parameters/Limit' + - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.2.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.2.0#/components/schemas/GetAssetAdministrationShellsResult' + '400': + $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.2.0#/components/responses/bad-request' + '401': + $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.2.0#/components/responses/unauthorized' + '403': + $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.2.0#/components/responses/forbidden' + '500': + $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.2.0#/components/responses/internal-server-error' + default: + $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.2.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/2 + requestBody: + description: Asset Administration Shell object + content: + application/json: + schema: + $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.2.0#/components/schemas/AssetAdministrationShell' + required: true + responses: + '201': + description: Asset Administration Shell created successfully + headers: + Location: + description: URL of the newly created resource + schema: + type: string + content: + application/json: + schema: + $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.2.0#/components/schemas/AssetAdministrationShell' + '400': + $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.2.0#/components/responses/bad-request' + '401': + $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.2.0#/components/responses/unauthorized' + '403': + $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.2.0#/components/responses/forbidden' + '409': + $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.2.0#/components/responses/conflict' + '500': + $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.2.0#/components/responses/internal-server-error' + default: + $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.2.0#/components/responses/default' + /shells/{aasIdentifier}: + parameters: + - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.2.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/2 + responses: + '200': + description: Requested Asset Administration Shell + content: + application/json: + schema: + $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.2.0#/components/schemas/AssetAdministrationShell' + '400': + $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.2.0#/components/responses/bad-request' + '401': + $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.2.0#/components/responses/unauthorized' + '403': + $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.2.0#/components/responses/forbidden' + '404': + $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.2.0#/components/responses/not-found' + '500': + $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.2.0#/components/responses/internal-server-error' + default: + $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.2.0#/components/responses/default' + put: + tags: + - Asset Administration Shell Repository API + summary: Creates or updates an existing Asset Administration Shell + operationId: PutAssetAdministrationShellById + x-semanticIds: + - https://admin-shell.io/aas/API/PutAssetAdministrationShellById/3/2 + requestBody: + description: Asset Administration Shell object + content: + application/json: + schema: + $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.2.0#/components/schemas/AssetAdministrationShell' + required: true + responses: + '201': + description: Asset Administration Shell created successfully + headers: + Location: + description: URL of the newly created resource + schema: + type: string + content: + application/json: + schema: + $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.2.0#/components/schemas/AssetAdministrationShell' + '204': + description: Asset Administration Shell updated successfully + '400': + $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.2.0#/components/responses/bad-request' + '401': + $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.2.0#/components/responses/unauthorized' + '403': + $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.2.0#/components/responses/forbidden' + '500': + $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.2.0#/components/responses/internal-server-error' + default: + $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.2.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/2 + responses: + '204': + description: Asset Administration Shell deleted successfully + '401': + $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.2.0#/components/responses/unauthorized' + '403': + $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.2.0#/components/responses/forbidden' + '404': + description: Not Found + content: + application/json: + schema: + $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.2.0#/components/schemas/Result' + '500': + $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.2.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.2.0#/components/schemas/Result' + /shells/{aasIdentifier}/asset-information/thumbnail: + parameters: + - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.2.0#/components/parameters/AssetAdministrationShellIdentifier' + get: + tags: + - Asset Administration Shell Repository API + operationId: GetThumbnail_AasRepository + x-semanticIds: + - https://admin-shell.io/aas/API/GetThumbnail/3/2 + 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.2.0#/components/responses/bad-request' + '401': + $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.2.0#/components/responses/unauthorized' + '403': + $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.2.0#/components/responses/forbidden' + '404': + $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.2.0#/components/responses/not-found' + '500': + $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.2.0#/components/responses/internal-server-error' + default: + $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.2.0#/components/responses/default' + put: + tags: + - Asset Administration Shell Repository API + operationId: PutThumbnail_AasRepository + x-semanticIds: + - https://admin-shell.io/aas/API/PutThumbnail/3/2 + 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.2.0#/components/responses/bad-request' + '401': + $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.2.0#/components/responses/unauthorized' + '403': + $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.2.0#/components/responses/forbidden' + '404': + $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.2.0#/components/responses/not-found' + '500': + $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.2.0#/components/responses/internal-server-error' + default: + $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.2.0#/components/responses/default' + delete: + tags: + - Asset Administration Shell Repository API + operationId: DeleteThumbnail_AasRepository + x-semanticIds: + - https://admin-shell.io/aas/API/DeleteThumbnail/3/2 + responses: + '200': + description: >- + Thumbnail deletion successful. + Deprecated: Use response code 204 instead. + '204': + $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.2.0#/components/responses/no-content' + '400': + $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.2.0#/components/responses/bad-request' + '401': + $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.2.0#/components/responses/unauthorized' + '403': + $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.2.0#/components/responses/forbidden' + '404': + $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.2.0#/components/responses/not-found' + '500': + $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.2.0#/components/responses/internal-server-error' + default: + $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.2.0#/components/responses/default' + /shells/{aasIdentifier}/submodels/{submodelIdentifier}: + parameters: + - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.2.0#/components/parameters/AssetAdministrationShellIdentifier' + - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.2.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/2 + parameters: + - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.2.0#/components/parameters/Level' + - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.2.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.2.0#/components/schemas/Submodel' + '400': + $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.2.0#/components/responses/bad-request' + '401': + $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.2.0#/components/responses/unauthorized' + '403': + $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.2.0#/components/responses/forbidden' + '404': + $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.2.0#/components/responses/not-found' + '500': + $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.2.0#/components/responses/internal-server-error' + default: + $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.2.0#/components/responses/default' + put: + tags: + - Asset Administration Shell Repository API + summary: Creates or updates the Submodel + operationId: PutSubmodelById_AasRepository + x-semanticIds: + - https://admin-shell.io/aas/API/PutSubmodelById/3/2 + requestBody: + description: Submodel object + content: + application/json: + schema: + $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.2.0#/components/schemas/Submodel' + required: true + responses: + '201': + description: Submodel reference created successfully + headers: + Location: + description: URL of the newly created resource + schema: + type: string + content: + application/json: + schema: + $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.2.0#/components/schemas/Reference' + '204': + description: Submodel updated successfully + '400': + $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.2.0#/components/responses/bad-request' + '401': + $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.2.0#/components/responses/unauthorized' + '403': + $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.2.0#/components/responses/forbidden' + '404': + $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.2.0#/components/responses/not-found' + '500': + $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.2.0#/components/responses/internal-server-error' + default: + $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.2.0#/components/responses/default' + 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/2 + responses: + '204': + description: Submodel deleted successfully + '400': + $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.2.0#/components/responses/bad-request' + '401': + $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.2.0#/components/responses/unauthorized' + '403': + $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.2.0#/components/responses/forbidden' + '404': + $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.2.0#/components/responses/not-found' + '500': + $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.2.0#/components/responses/internal-server-error' + default: + $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.2.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.2.0#/components/parameters/AssetAdministrationShellIdentifier' + - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.2.0#/components/parameters/SubmodelIdentifier' + - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.2.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/2 + 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.2.0#/components/responses/bad-request' + '401': + $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.2.0#/components/responses/unauthorized' + '403': + $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.2.0#/components/responses/forbidden' + '404': + $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.2.0#/components/responses/not-found' + '500': + $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.2.0#/components/responses/internal-server-error' + default: + $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.2.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/2 + 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.2.0#/components/responses/bad-request' + '401': + $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.2.0#/components/responses/unauthorized' + '403': + $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.2.0#/components/responses/forbidden' + '404': + $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.2.0#/components/responses/not-found' + '500': + $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.2.0#/components/responses/internal-server-error' + default: + $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.2.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/2 + responses: + '200': + description: Submodel element updated successfully + '400': + $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.2.0#/components/responses/bad-request' + '401': + $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.2.0#/components/responses/unauthorized' + '403': + $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.2.0#/components/responses/forbidden' + '404': + $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.2.0#/components/responses/not-found' + '500': + $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.2.0#/components/responses/internal-server-error' + default: + $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.2.0#/components/responses/default' + + /description: + get: + tags: + - Description API + summary: Returns the self-describing information of a network resource (ServiceDescription) + operationId: GetSelfDescription + x-semanticIds: + - https://admin-shell.io/aas/API/GetSelfDescription/3/2 + responses: + '200': + description: Requested Description + content: + application/json: + schema: + $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.2.0#/components/schemas/ServiceDescription' + '401': + $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.2.0#/components/responses/unauthorized' + '403': + $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.2.0#/components/responses/forbidden' diff --git a/documentation/IDTA-01002-3/modules/ROOT/pages/changelog.adoc b/documentation/IDTA-01002-3/modules/ROOT/pages/changelog.adoc index fb4607d5..adfd5b0c 100644 --- a/documentation/IDTA-01002-3/modules/ROOT/pages/changelog.adoc +++ b/documentation/IDTA-01002-3/modules/ROOT/pages/changelog.adoc @@ -15,6 +15,7 @@ Note: Changes in Metamodel (IDTA-01001) will not be listed here, although they h Major Changes: * ... +* Added a new profile for the AAS Repository Service Specification, the "Identifiable Profile", which only includes operations that require an identifier as input parameter. (https://github.com/admin-shell-io/aas-specs-api/issues/496[#496]) Minor Changes: diff --git a/documentation/IDTA-01002-3/modules/ROOT/pages/http-rest-api/service-specifications-and-profiles.adoc b/documentation/IDTA-01002-3/modules/ROOT/pages/http-rest-api/service-specifications-and-profiles.adoc index e282da3b..f5a0b9ae 100644 --- a/documentation/IDTA-01002-3/modules/ROOT/pages/http-rest-api/service-specifications-and-profiles.adoc +++ b/documentation/IDTA-01002-3/modules/ROOT/pages/http-rest-api/service-specifications-and-profiles.adoc @@ -674,6 +674,7 @@ h|Service Specification / Profiles h|Description |<> |Full feature set |<> |Only read operations; is included in the profile AssetAdministrationShellRepositoryServiceSpecification/SSP-001 |<> |Query operations +|<> |Operations on Identifiables only; is included in the profile AssetAdministrationShellRepositoryServiceSpecification/SSP-001 |=== [#asset-administration-shell-repository-service-specification-service-specification-ssp-001] @@ -825,6 +826,57 @@ xref:specification/interfaces.adoc#GetSelfDescription[GetDescription] See: https://app.swaggerhub.com/apis/Plattform_i40/AssetAdministrationShellRepositoryServiceSpecification/V3.2.0_SSP-003 + +[#asset-administration-shell-repository-service-specification-service-specification-ssp-004] +=== Asset Administration Shell Repository Service Specification – Identifiable Profile + +[%autowidth,width="100%",cols="30%,70%",options="header",] +|=== +h|Name: h|AAS Repository Identifiable Profile +h|Profile Identifier: |`\https://admin-shell.io/aas/API/3/2/AssetAdministrationShellRepositoryServiceSpecification/SSP-004` +h|Feature h|Appearance +|API and API Operations a| +_AAS Repository API:_ + +xref:specification/interfaces.adoc#GetAssetAdministrationShellById[GetAssetAdministrationShellById] + +xref:specification/interfaces.adoc#PostAssetAdministrationShell[PostAssetAdministrationShell] + +xref:specification/interfaces.adoc#PutAssetAdministrationShellById[PutAssetAdministrationShellById] + +xref:specification/interfaces.adoc#DeleteAssetAdministrationShellById[DeleteAssetAdministrationShellById] + +_AAS API by superpath:_ + +xref:specification/interfaces.adoc#GetThumbnail[GetThumbnail] + +xref:specification/interfaces.adoc#PutThumbnail[PutThumbnail] + +xref:specification/interfaces.adoc#DeleteThumbnail[DeleteThumbnail] + +__Submodel Repository API by superpath:__ + +xref:specification/interfaces.adoc#GetSubmodelById[GetSubmodelById] + +xref:specification/interfaces.adoc#PostSubmodel[PostSubmodel] + +xref:specification/interfaces.adoc#PutSubmodelById[PutSubmodelById] + +xref:specification/interfaces.adoc#DeleteSubmodelById[DeleteSubmodelById] + +__Submodel API by superpath:__ + +xref:specification/interfaces.adoc#GetFileByPath[GetFileByPath] + +xref:specification/interfaces.adoc#PutFileByPath[PutFileByPath] + +xref:specification/interfaces.adoc#DeleteFileByPath[DeleteFileByPath] + + +_Description API:_ + +xref:specification/interfaces.adoc#GetSelfDescription[GetDescription] + +|xref:specification/interfaces-operation-parameters.adoc#SerializationModifier[SerializationModifier] a| +Level: Deep + +Content: Normal + +Extent: WithoutBLOBValue + +|SerializationFormat |JSON +|xref:http-rest-api/http-rest-api.adoc#pagination[Pagination] |supported +|=== + +See: https://app.swaggerhub.com/apis/Plattform_i40/AssetAdministrationShellRepositoryServiceSpecification/V3.2.0_SSP-004 + + + [[submodel-repository-service-specification]] == Submodel Repository Service Specification diff --git a/documentation/IDTA-01002-3/modules/ROOT/pages/specification/interfaces-payload.adoc b/documentation/IDTA-01002-3/modules/ROOT/pages/specification/interfaces-payload.adoc index 8330d233..aa608489 100644 --- a/documentation/IDTA-01002-3/modules/ROOT/pages/specification/interfaces-payload.adoc +++ b/documentation/IDTA-01002-3/modules/ROOT/pages/specification/interfaces-payload.adoc @@ -354,6 +354,7 @@ e|https://admin-shell.io/aas/API/3/0/AssetAdministrationShellRepositoryServiceSp e|https://admin-shell.io/aas/API/3/1/AssetAdministrationShellRepositoryServiceSpecification/SSP-001 |Indicates that the server implemented all details of the Asset Administration Shell Repository Service Specification Full Profile in version 3.1. e|https://admin-shell.io/aas/API/3/0/AssetAdministrationShellRepositoryServiceSpecification/SSP-002 |Indicates that the server implemented all details of the Asset Administration Shell Repository Service Specification Read Profile in version 3.0. e|https://admin-shell.io/aas/API/3/1/AssetAdministrationShellRepositoryServiceSpecification/SSP-002 |Indicates that the server implemented all details of the Asset Administration Shell Repository Service Specification Read Profile in version 3.1. +e|https://admin-shell.io/aas/API/3/2/AssetAdministrationShellRepositoryServiceSpecification/SSP-004 |Indicates that the server implemented all details of the Asset Administration Shell Repository Service Specification Identifiable Profile in version 3.2. e|https://admin-shell.io/aas/API/3/0/SubmodelRepositoryServiceSpecification/SSP-001 |Indicates that the server implemented all details of the Submodel Service Repository Specification Full Profile in version 3.0. e|https://admin-shell.io/aas/API/3/1/SubmodelRepositoryServiceSpecification/SSP-001 |Indicates that the server implemented all details of the Submodel Service Repository Specification Full Profile in version 3.1. e|https://admin-shell.io/aas/API/3/0/SubmodelRepositoryServiceSpecification/SSP-002 |Indicates that the server implemented all details of the Submodel Service Repository Specification Read Profile in version 3.0.