aas-specs-api/SubmodelRegistryServiceSpecification/V3.1_SSP-003.yaml at main · alexgordtop/aas-specs-api · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
openapi: 3.1.0
info:
  title: DotAAS Part 2 | HTTP/REST | Bulk Submodel Registry Service Specification
  description: >-
    The Bulk Profile of the Submodel Registry Service Specification as part of the [Specification of the Asset Administration Shell: Part 2](https://industrialdigitaltwin.org/content-hub/aasspecifications).

    The server processes all requests asynchronously, ensuring atomic
    operations. This means that requested manipulations will either fully
    succeed or be completely rolled back if any error occurs during the process.

    Copyright: Industrial Digital Twin Association (IDTA) 2025
  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.1.0_SSP-003
  x-profile-identifier: https://admin-shell.io/aas/API/3/1/SubmodelRegistryServiceSpecification/SSP-003
servers:
- url: 'https://admin-shell.io/api/v3/'
- url: 'https://example.com/'

paths:
  /bulk/submodel-descriptors:
    post:
      tags:
      - Async Bulk Submodel Registry API
      summary: Creates multiple new Submodel Descriptors
      operationId: CreateBulkSubmodelDescriptors
      x-semanticIds:
        - https://admin-shell.io/aas/API/CreateBulkSubmodelDescriptors/3/1
      requestBody:
        description: List of Submodel Descriptor objects
        content:
          application/json:
            schema:
              type: array
              minItems: 1
              items:
                $ref: "https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.1.0#/components/schemas/SubmodelDescriptor"
        required: true
      responses:
        '202':
          $ref: "https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.1.0#/components/responses/accepted"
        '400':
          $ref: "https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.1.0#/components/responses/bad-request"
        '401':
          $ref: "https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.1.0#/components/responses/unauthorized"
        '403':
          $ref: "https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.1.0#/components/responses/forbidden"
        '500':
          $ref: "https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.1.0#/components/responses/internal-server-error"
    put:
      tags:
      - Async Bulk Submodel Registry API
      summary: Creates or updates multiple existing Submodel Descriptors
      operationId: PutBulkSubmodelDescriptorsById
      x-semanticIds:
        - https://admin-shell.io/aas/API/PutBulkSubmodelDescriptorsById/3/1
      requestBody:
        description: List of Submodel Descriptor objects
        content:
          application/json:
            schema:
              type: array
              minItems: 1
              items:
                $ref: "https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.1.0#/components/schemas/SubmodelDescriptor"
        required: true
      responses:
        '202':
          $ref: "https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.1.0#/components/responses/accepted"
        '400':
          $ref: "https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.1.0#/components/responses/bad-request"
        '401':
          $ref: "https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.1.0#/components/responses/unauthorized"
        '403':
          $ref: "https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.1.0#/components/responses/forbidden"
        '500':
          $ref: "https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.1.0#/components/responses/internal-server-error"
    delete:
      tags:
      - Async Bulk Submodel Registry API
      summary: Deletes multiple Submodel Descriptors
      operationId: DeleteBulkSubmodelDescriptorsById
      x-semanticIds:
        - https://admin-shell.io/aas/API/DeleteBulkSubmodelDescriptorsById/3/1
      requestBody:
        description: List of Submodel Identifiers
        content:
          application/json:
            schema:
              type: array
              minItems: 1
              items:
                type: string
      responses:
        '202':
          $ref: "https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.1.0#/components/responses/accepted"
        '400':
          $ref: "https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.1.0#/components/responses/bad-request"
        '401':
          $ref: "https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.1.0#/components/responses/unauthorized"
        '403':
          $ref: "https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.1.0#/components/responses/forbidden"
        '500':
          $ref: "https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.1.0#/components/responses/internal-server-error"
  /bulk/status/{handleId}:
    get:
      tags:
        - Async Bulk Status API
      summary: Returns the status of an asynchronously invoked bulk operation
      operationId: GetBulkAsyncStatus
      x-semanticIds:
        - https://admin-shell.io/aas/API/GetBulkAsyncStatus/3/1
      parameters:
        - in: path
          name: handleId
          schema:
            $ref: "https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.1.0#/components/parameters/HandleId"
          required: true
      responses:
        '200':
          description: Bulk operation result object containing information that the
            'executionState' is still 'Running'
          headers:
            Retry-After:
              schema:
                type: integer
              required: false
              description: The number of seconds to wait before retrying the request.
          content:
            application/json:
              schema:
                $ref: "https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.1.0#/components/schemas/BaseOperationResult"
        '302':
          $ref: "https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.1.0#/components/responses/found"
        '401':
          $ref: "https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.1.0#/components/responses/unauthorized"
        '403':
          $ref: "https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.1.0#/components/responses/forbidden"
        '404':
          $ref: "https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.1.0#/components/responses/not-found"
        '500':
          $ref: "https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.1.0#/components/responses/internal-server-error"
  /bulk/result/{handleId}:
    get:
      tags:
        - Async Bulk Result API
      summary: Returns the result object of an asynchronously invoked bulk operation
      operationId: GetBulkAsyncResult
      x-semanticIds:
        - https://admin-shell.io/aas/API/GetBulkAsyncResult/3/1
      parameters:
        - in: path
          name: handleId
          schema:
            $ref: "https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.1.0#/components/parameters/HandleId"
          required: true
      responses:
        '204':
          description: The bulk request itself was correct and all elements have been
            processed. The server may remove the result resource after  it was
            requested once (by any client) or after a certain time period.
        '400':
          description: There was an error in the processing of the request. Either the bulk
            request itself was not correct, or at least of it's part requests.
            The whole transaction has been rolled back.
          $ref: "https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.1.0#/components/responses/bad-request"
        '401':
          $ref: "https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.1.0#/components/responses/unauthorized"
        '403':
          $ref: "https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.1.0#/components/responses/forbidden"
        '404':
          description: The handleId is not known to the server. This means either it never
            came into existence or it was successfully completed a considerable
            time in the past.
          $ref: "https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.1.0#/components/responses/not-found"
        '500':
          $ref: "https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.1.0#/components/responses/internal-server-error"
  /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/1
      responses:
        '200':
          description: Requested Description
          content:
            application/json:
              schema:
                $ref: "https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.1.0#/components/schemas/ServiceDescription"
        '403':
          $ref: "https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.1.0#/components/responses/forbidden"
        default:
          $ref: "https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.1.0#/components/responses/default"