From 704a71c14f91d55a25f98c653ee38efa73cac86a Mon Sep 17 00:00:00 2001 From: ds-pweick <162321742+ds-pweick@users.noreply.github.com> Date: Thu, 27 Jun 2024 05:55:32 +0000 Subject: [PATCH] chore(docs): updated docs and Helm chart for IRS release 5.1.5 --- CHANGELOG.md | 5 +- charts/item-relationship-service/CHANGELOG.md | 6 + charts/item-relationship-service/Chart.yaml | 4 +- docs/src/api/irs-api.yaml | 1505 ++++++++--------- .../eclipse/tractusx/irs/IrsApplication.java | 2 +- 5 files changed, 736 insertions(+), 786 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 47c1cd3419..c7bec4185e 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -8,6 +8,8 @@ _**For better traceability add the corresponding GitHub issue number in each cha ## [Unreleased] +## [5.1.5] - 2024-06-27 + ### Fixed - Fixed ESS Investigation job processing not starting #579 @@ -697,7 +699,8 @@ _**For better traceability add the corresponding GitHub issue number in each cha - **Select Aspects you need** You are able to select the needed aspects for which you want to collect the correct endpoint information. -[Unreleased]: https://github.com/eclipse-tractusx/item-relationship-service/compare/5.1.4...HEAD +[Unreleased]: https://github.com/eclipse-tractusx/item-relationship-service/compare/5.1.5...HEAD +[5.1.5]: https://github.com/eclipse-tractusx/item-relationship-service/compare/5.1.4...5.1.5 [5.1.4]: https://github.com/eclipse-tractusx/item-relationship-service/compare/5.1.3...5.1.4 [5.1.3]: https://github.com/eclipse-tractusx/item-relationship-service/compare/5.1.2...5.1.3 [5.1.2]: https://github.com/eclipse-tractusx/item-relationship-service/compare/5.1.1...5.1.2 diff --git a/charts/item-relationship-service/CHANGELOG.md b/charts/item-relationship-service/CHANGELOG.md index 3392764545..758297791a 100644 --- a/charts/item-relationship-service/CHANGELOG.md +++ b/charts/item-relationship-service/CHANGELOG.md @@ -6,6 +6,12 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 ## [Unreleased] +## [7.1.5] - 2024-06-27 + +### Changed + +- Update IRS version to 5.1.5 + ## [7.1.4] - 2024-05-27 diff --git a/charts/item-relationship-service/Chart.yaml b/charts/item-relationship-service/Chart.yaml index 5eb5360ab9..e5690750a9 100644 --- a/charts/item-relationship-service/Chart.yaml +++ b/charts/item-relationship-service/Chart.yaml @@ -35,12 +35,12 @@ type: application # This is the chart version. This version number should be incremented each time you make changes # to the chart and its templates, including the app version. # Versions are expected to follow Semantic Versioning (https://semver.org/) -version: 7.1.4 +version: 7.1.5 # This is the version number of the application being deployed. This version number should be # incremented each time you make changes to the application. Versions are not expected to # follow Semantic Versioning. They should reflect the version the application is using. # It is recommended to use it with quotes. -appVersion: "5.1.4" +appVersion: "5.1.5" dependencies: - name: common repository: https://charts.bitnami.com/bitnami diff --git a/docs/src/api/irs-api.yaml b/docs/src/api/irs-api.yaml index 8580810ea0..374777c909 100644 --- a/docs/src/api/irs-api.yaml +++ b/docs/src/api/irs-api.yaml @@ -1,18 +1,16 @@ openapi: 3.0.1 info: - description: The API of the Item Relationship Service (IRS) for retrieving item - graphs along the value chain of CATENA-X partners. + description: The API of the Item Relationship Service (IRS) for retrieving item graphs along the value chain of CATENA-X partners. title: IRS API - version: 5.1.4 + version: 5.1.5 servers: -- url: http://localhost:8080 + - url: http://localhost:8080 security: -- api_key: [] + - api_key: [] paths: /ess/bpn/investigations: post: - description: Registers an IRS job to start an investigation if a given bpn is - contained in a part chain of a given globalAssetId. + description: Registers an IRS job to start an investigation if a given bpn is contained in a part chain of a given globalAssetId. operationId: registerBPNInvestigation requestBody: content: @@ -58,24 +56,23 @@ paths: $ref: '#/components/schemas/ErrorResponse' description: Authorization refused by server. security: - - api_key: [] - summary: Registers an IRS job to start an investigation if a given bpn is contained - in a part chain of a given globalAssetId. + - api_key: [] + summary: Registers an IRS job to start an investigation if a given bpn is contained in a part chain of a given globalAssetId. tags: - - Environmental and Social Standards + - Environmental and Social Standards /ess/bpn/investigations/{id}: get: description: Return job with additional supplyChainImpacted information. operationId: getBPNInvestigation parameters: - - description: Id of the job. - example: 6c311d29-5753-46d4-b32c-19b918ea93b0 - in: path - name: id - required: true - schema: - type: string - format: uuid + - description: Id of the job. + example: 6c311d29-5753-46d4-b32c-19b918ea93b0 + in: path + name: id + required: true + schema: + type: string + format: uuid responses: "200": content: @@ -123,14 +120,13 @@ paths: $ref: '#/components/schemas/ErrorResponse' description: Job with the requested jobId not found. security: - - api_key: [] + - api_key: [] summary: Return job with additional supplyChainImpacted information. tags: - - Environmental and Social Standards + - Environmental and Social Standards /ess/notification/receive: post: - description: Accepts notifications via EDC. Notifications are filtered by their - type and processed accordingly. + description: Accepts notifications via EDC. Notifications are filtered by their type and processed accordingly. operationId: receiveEdcNotification requestBody: content: @@ -152,7 +148,7 @@ paths: description: Notification malformed. summary: Accepts notifications sent via EDC. tags: - - Environmental and Social Standards + - Environmental and Social Standards /irs/aspectmodels: get: description: Get all available aspect models from semantic hub or local models. @@ -186,14 +182,13 @@ paths: $ref: '#/components/schemas/ErrorResponse' description: Authorization refused by server. security: - - api_key: [] + - api_key: [] summary: Get all available aspect models from semantic hub or local models. tags: - - Aspect Models + - Aspect Models /irs/ess/orders: post: - description: "Registers an order for an ESS investigation with an array of {globalAssetIds}.\ - \ Each globalAssetId will be processed in an separate job, grouped in batches." + description: "Registers an order for an ESS investigation with an array of {globalAssetIds}. Each globalAssetId will be processed in an separate job, grouped in batches." operationId: registerESSInvestigationOrder requestBody: content: @@ -239,65 +234,62 @@ paths: $ref: '#/components/schemas/ErrorResponse' description: Authorization refused by server. security: - - api_key: [] - summary: "Registers an order for an ESS investigation with an array of {globalAssetIds}.\ - \ Each globalAssetId will be processed in an separate job, grouped in batches." + - api_key: [] + summary: "Registers an order for an ESS investigation with an array of {globalAssetIds}. Each globalAssetId will be processed in an separate job, grouped in batches." tags: - - Environmental and Social Standards + - Environmental and Social Standards /irs/jobs: get: description: Returns paginated jobs with state and execution times. operationId: getJobsByJobStates parameters: - - description: Requested job states. - explode: false - in: query - name: states - required: false - schema: - type: array - items: - type: string - enum: - - UNSAVED - - INITIAL - - RUNNING - - TRANSFERS_FINISHED - - COMPLETED - - CANCELED - - ERROR - maxItems: 2147483647 - - description: Zero-based page index (0..N) - in: query - name: page - required: false - schema: - type: integer - default: 0 - - description: The size of the page to be returned - in: query - name: size - required: false - schema: - type: integer - default: 20 - - description: "Sorting criteria in the format: property,(asc|desc). Default\ - \ sort order is ascending. Multiple sort criteria are supported." - in: query - name: sort - required: false - schema: - type: array - items: - type: string + - description: Requested job states. + explode: false + in: query + name: states + required: false + schema: + type: array + items: + type: string + enum: + - UNSAVED + - INITIAL + - RUNNING + - TRANSFERS_FINISHED + - COMPLETED + - CANCELED + - ERROR + maxItems: 2147483647 + - description: Zero-based page index (0..N) + in: query + name: page + required: false + schema: + type: integer + default: 0 + - description: The size of the page to be returned + in: query + name: size + required: false + schema: + type: integer + default: 20 + - description: "Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported." + in: query + name: sort + required: false + schema: + type: array + items: + type: string responses: "200": content: application/json: schema: $ref: '#/components/schemas/PageResult' - description: Paginated list of jobs with state and execution times for requested - job states. + description: Paginated list of jobs with state and execution times for requested job states. "400": content: application/json: @@ -326,10 +318,10 @@ paths: $ref: '#/components/schemas/ErrorResponse' description: Authorization refused by server. security: - - api_key: [] + - api_key: [] summary: Returns paginated jobs with state and execution times. tags: - - Item Relationship Service + - Item Relationship Service post: description: "Register an IRS job to retrieve an item graph for given {globalAssetId}." operationId: registerJobForGlobalAssetId @@ -377,34 +369,32 @@ paths: $ref: '#/components/schemas/ErrorResponse' description: Authorization refused by server. security: - - api_key: [] + - api_key: [] summary: "Register an IRS job to retrieve an item graph for given {globalAssetId}." tags: - - Item Relationship Service + - Item Relationship Service /irs/jobs/{id}: get: description: Return job with optional item graph result for requested id. operationId: getJobForJobId parameters: - - description: Id of the job. - example: 6c311d29-5753-46d4-b32c-19b918ea93b0 - in: path - name: id - required: true - schema: - type: string - format: uuid - maxLength: 36 - minLength: 36 - - description: "\\ Return job with current processed item graph. \\\ - Return job with item graph if job is in state COMPLETED, otherwise\ - \ job." - in: query - name: returnUncompletedJob - required: false - schema: - type: boolean - default: true + - description: Id of the job. + example: 6c311d29-5753-46d4-b32c-19b918ea93b0 + in: path + name: id + required: true + schema: + type: string + format: uuid + maxLength: 36 + minLength: 36 + - description: "\\ Return job with current processed item graph. \\ Return job with item graph if job is in state COMPLETED, otherwise job." + in: query + name: returnUncompletedJob + required: false + schema: + type: boolean + default: true responses: "200": content: @@ -423,8 +413,7 @@ paths: $ref: '#/components/examples/partial-job-result' schema: $ref: '#/components/schemas/Jobs' - description: Return job with current processed item graph for the requested - id. + description: Return job with current processed item graph for the requested id. "400": content: application/json: @@ -462,24 +451,24 @@ paths: $ref: '#/components/schemas/ErrorResponse' description: Job with the requested jobId not found. security: - - api_key: [] + - api_key: [] summary: Return job with optional item graph result for requested id. tags: - - Item Relationship Service + - Item Relationship Service put: description: Cancel job for requested jobId. operationId: cancelJobByJobId parameters: - - description: Id of the job. - example: 6c311d29-5753-46d4-b32c-19b918ea93b0 - in: path - name: id - required: true - schema: - type: string - format: uuid - maxLength: 36 - minLength: 36 + - description: Id of the job. + example: 6c311d29-5753-46d4-b32c-19b918ea93b0 + in: path + name: id + required: true + schema: + type: string + format: uuid + maxLength: 36 + minLength: 36 responses: "200": content: @@ -527,14 +516,13 @@ paths: $ref: '#/components/schemas/ErrorResponse' description: Job for requested jobId not found. security: - - api_key: [] + - api_key: [] summary: Cancel job for requested jobId. tags: - - Item Relationship Service + - Item Relationship Service /irs/orders: post: - description: "Registers an IRS order with an array of {globalAssetIds}. Each\ - \ globalAssetId will be processed in an IRS Job, grouped in batches." + description: "Registers an IRS order with an array of {globalAssetIds}. Each globalAssetId will be processed in an IRS Job, grouped in batches." operationId: registerOrder requestBody: content: @@ -580,26 +568,25 @@ paths: $ref: '#/components/schemas/ErrorResponse' description: Authorization refused by server. security: - - api_key: [] - summary: "Registers an IRS order with an array of {globalAssetIds}. Each globalAssetId\ - \ will be processed in an IRS Job, grouped in batches." + - api_key: [] + summary: "Registers an IRS order with an array of {globalAssetIds}. Each globalAssetId will be processed in an IRS Job, grouped in batches." tags: - - Item Relationship Service + - Item Relationship Service /irs/orders/{orderId}: get: description: Get a batch order for a given orderId. operationId: getBatchOrder parameters: - - description: Id of the order. - example: 6c311d29-5753-46d4-b32c-19b918ea93b0 - in: path - name: orderId - required: true - schema: - type: string - format: uuid - maxLength: 36 - minLength: 36 + - description: Id of the order. + example: 6c311d29-5753-46d4-b32c-19b918ea93b0 + in: path + name: orderId + required: true + schema: + type: string + format: uuid + maxLength: 36 + minLength: 36 responses: "200": content: @@ -647,24 +634,24 @@ paths: $ref: '#/components/schemas/ErrorResponse' description: Batch Order with the requested orderId not found. security: - - api_key: [] + - api_key: [] summary: Get a batch order for a given orderId. tags: - - Item Relationship Service + - Item Relationship Service put: description: Cancel a batch order for a given orderId. operationId: cancelBatchOrder parameters: - - description: Id of the order. - example: 6c311d29-5753-46d4-b32c-19b918ea93b0 - in: path - name: orderId - required: true - schema: - type: string - format: uuid - maxLength: 36 - minLength: 36 + - description: Id of the order. + example: 6c311d29-5753-46d4-b32c-19b918ea93b0 + in: path + name: orderId + required: true + schema: + type: string + format: uuid + maxLength: 36 + minLength: 36 responses: "200": content: @@ -712,35 +699,35 @@ paths: $ref: '#/components/schemas/ErrorResponse' description: Batch Order with the requested orderId not found. security: - - api_key: [] + - api_key: [] summary: Cancel a batch order for a given orderId. tags: - - Item Relationship Service + - Item Relationship Service /irs/orders/{orderId}/batches/{batchId}: get: description: Get a batch with a given batchId for a given orderId. operationId: getBatch parameters: - - description: Id of the order. - example: 6c311d29-5753-46d4-b32c-19b918ea93b0 - in: path - name: orderId - required: true - schema: - type: string - format: uuid - maxLength: 36 - minLength: 36 - - description: Id of the batch. - example: 4bce40b8-64c7-41bf-9ca3-e9432c7fef98 - in: path - name: batchId - required: true - schema: - type: string - format: uuid - maxLength: 36 - minLength: 36 + - description: Id of the order. + example: 6c311d29-5753-46d4-b32c-19b918ea93b0 + in: path + name: orderId + required: true + schema: + type: string + format: uuid + maxLength: 36 + minLength: 36 + - description: Id of the batch. + example: 4bce40b8-64c7-41bf-9ca3-e9432c7fef98 + in: path + name: batchId + required: true + schema: + type: string + format: uuid + maxLength: 36 + minLength: 36 responses: "200": content: @@ -788,51 +775,51 @@ paths: $ref: '#/components/schemas/ErrorResponse' description: Batch with the requested orderId and batchId not found. security: - - api_key: [] + - api_key: [] summary: Get a batch with a given batchId for a given orderId. tags: - - Item Relationship Service + - Item Relationship Service /irs/policies: get: description: Lists the registered policies that should be accepted in EDC negotiation. operationId: getAllowedPoliciesByBpn parameters: - - description: List of business partner numbers. - in: query - name: businessPartnerNumbers - required: false - schema: - type: array - items: - type: string + - description: List of business partner numbers. + in: query + name: businessPartnerNumbers + required: false + schema: + type: array + items: + type: string responses: "200": content: application/json: example: BPNL1234567890AB: - - validUntil: 2025-12-12T23:59:59.999Z - payload: - '@context': - odrl: http://www.w3.org/ns/odrl/2/ - '@id': e917f5f-8dac-49ac-8d10-5b4d254d2b48 - policy: - policyId: e917f5f-8dac-49ac-8d10-5b4d254d2b48 - createdOn: 2024-03-28T03:34:42.9454448Z - validUntil: 2025-12-12T23:59:59.999Z - permissions: - - action: use - constraint: - and: - - leftOperand: Membership - operator: - '@id': eq - rightOperand: active - - leftOperand: PURPOSE - operator: - '@id': eq - rightOperand: ID 3.1 Trace - or: null + - validUntil: 2025-12-12T23:59:59.999Z + payload: + '@context': + odrl: http://www.w3.org/ns/odrl/2/ + '@id': e917f5f-8dac-49ac-8d10-5b4d254d2b48 + policy: + policyId: e917f5f-8dac-49ac-8d10-5b4d254d2b48 + createdOn: 2024-03-28T03:34:42.9454448Z + validUntil: 2025-12-12T23:59:59.999Z + permissions: + - action: use + constraint: + and: + - leftOperand: Membership + operator: + '@id': eq + rightOperand: active + - leftOperand: PURPOSE + operator: + '@id': eq + rightOperand: ID 3.1 Trace + or: null BPNA1234567890DF: [] schema: type: string @@ -857,10 +844,10 @@ paths: $ref: '#/components/schemas/ErrorResponse' description: Authorization refused by server. security: - - api_key: [] + - api_key: [] summary: Lists the registered policies that should be accepted in EDC negotiation. tags: - - Item Relationship Service + - Item Relationship Service post: description: Register a policy that should be accepted in EDC negotiation. operationId: registerAllowedPolicy @@ -914,10 +901,10 @@ paths: $ref: '#/components/schemas/ErrorResponse' description: Policy registration failed due to an internal error. security: - - api_key: [] + - api_key: [] summary: Register a policy that should be accepted in EDC negotiation. tags: - - Item Relationship Service + - Item Relationship Service put: description: Updates existing policies. operationId: updateAllowedPolicy @@ -967,20 +954,20 @@ paths: $ref: '#/components/schemas/ErrorResponse' description: Updating policies failed due to an internal error. security: - - api_key: [] + - api_key: [] summary: Updates existing policies. tags: - - Item Relationship Service + - Item Relationship Service /irs/policies/{policyId}: delete: description: Removes a policy that should no longer be accepted in EDC negotiation. operationId: deleteAllowedPolicy parameters: - - in: path - name: policyId - required: true - schema: - type: string + - in: path + name: policyId + required: true + schema: + type: string responses: "200": description: OK @@ -1012,27 +999,26 @@ paths: $ref: '#/components/schemas/ErrorResponse' description: Authorization refused by server. security: - - api_key: [] + - api_key: [] summary: Removes a policy that should no longer be accepted in EDC negotiation. tags: - - Item Relationship Service + - Item Relationship Service /irs/policies/{policyId}/bpnl/{bpnl}: delete: - description: Removes a policy from BPNL that should no longer be accepted in - EDC negotiation. + description: Removes a policy from BPNL that should no longer be accepted in EDC negotiation. operationId: removeAllowedPolicyFromBpnl parameters: - - in: path - name: policyId - required: true - schema: - type: string - - in: path - name: bpnl - required: true - schema: - type: string - pattern: "(BPN)[LSA][\\w\\d]{10}[\\w\\d]{2}" + - in: path + name: policyId + required: true + schema: + type: string + - in: path + name: bpnl + required: true + schema: + type: string + pattern: "(BPN)[LSA][\\w\\d]{10}[\\w\\d]{2}" responses: "200": description: OK @@ -1064,27 +1050,26 @@ paths: $ref: '#/components/schemas/ErrorResponse' description: Authorization refused by server. security: - - api_key: [] - summary: Removes a policy from BPNL that should no longer be accepted in EDC - negotiation. + - api_key: [] + summary: Removes a policy from BPNL that should no longer be accepted in EDC negotiation. tags: - - Item Relationship Service + - Item Relationship Service components: examples: aspect-models-list: value: lastUpdated: 2023-02-13T08:18:11.990659500Z models: - - name: SingleLevelBomAsBuilt - status: RELEASED - type: SAMM - urn: urn:samm:io.catenax.single_level_bom_as_built:3.0.0#SingleLevelBomAsBuilt - version: 3.0.0 - - name: SerialPart - status: RELEASED - type: SAMM - urn: urn:samm:io.catenax.serial_part:3.0.0#SerialPart - version: 3.0.0 + - name: SingleLevelBomAsBuilt + status: RELEASED + type: SAMM + urn: urn:samm:io.catenax.single_level_bom_as_built:3.0.0#SingleLevelBomAsBuilt + version: 3.0.0 + - name: SerialPart + status: RELEASED + type: SAMM + urn: urn:samm:io.catenax.serial_part:3.0.0#SerialPart + version: 3.0.0 canceled-job-response: value: completedOn: 2022-02-03T14:48:54.709Z @@ -1108,8 +1093,8 @@ components: lastModifiedOn: 2022-02-03T14:48:54.709Z parameter: aspects: - - urn:samm:io.catenax.single_level_bom_as_built:3.0.0#SingleLevelBomAsBuilt - - urn:samm:io.catenax.serial_part:3.0.0#SerialPart + - urn:samm:io.catenax.single_level_bom_as_built:3.0.0#SingleLevelBomAsBuilt + - urn:samm:io.catenax.serial_part:3.0.0#SerialPart auditContractNegotiation: false bomLifecycle: asBuilt collectAspects: false @@ -1134,10 +1119,10 @@ components: batchTotal: 1 completedOn: 2022-02-03T14:48:54.709Z jobs: - - completedOn: 2022-02-03T14:48:54.709Z - id: 6c311d29-5753-46d4-b32c-19b918ea93b0 - startedOn: 2022-02-03T14:48:54.709Z - state: COMPLETED + - completedOn: 2022-02-03T14:48:54.709Z + id: 6c311d29-5753-46d4-b32c-19b918ea93b0 + startedOn: 2022-02-03T14:48:54.709Z + state: COMPLETED jobsInBatchChecksum: 1 orderId: f253718e-a270-4367-901b-9d50d9bd8462 startedOn: 2022-02-03T14:48:54.709Z @@ -1145,8 +1130,8 @@ components: complete-ess-job-result: value: bpns: - - manufacturerId: BPNL00000003AAXX - manufacturerName: AB CD + - manufacturerId: BPNL00000003AAXX + manufacturerName: AB CD job: completedOn: 2022-02-03T14:48:54.709Z createdOn: 2022-02-03T14:48:54.709Z @@ -1159,8 +1144,8 @@ components: lastModifiedOn: 2022-02-03T14:48:54.709Z parameter: aspects: - - urn:samm:io.catenax.single_level_bom_as_built:3.0.0#SingleLevelBomAsBuilt - - urn:samm:io.catenax.serial_part:3.0.0#SerialPart + - urn:samm:io.catenax.single_level_bom_as_built:3.0.0#SingleLevelBomAsBuilt + - urn:samm:io.catenax.serial_part:3.0.0#SerialPart auditContractNegotiation: false bomLifecycle: asBuilt collectAspects: false @@ -1175,92 +1160,92 @@ components: failed: 0 running: 0 relationships: - - catenaXId: urn:uuid:d9bec1c6-e47c-4d18-ba41-0a5fe8b7f447 - linkedItem: - assembledOn: 2022-02-03T14:48:54.709Z - childCatenaXId: urn:uuid:a45a2246-f6e1-42da-b47d-5c3b58ed62e9 - hasAlternatives: false - lastModifiedOn: 2022-02-03T14:48:54.709Z - lifecycleContext: asBuilt - quantity: - measurementUnit: - datatypeURI: urn:bamm:io.openmanufacturing:meta-model:1.0.0#piece - lexicalValue: piece - quantityNumber: 1.0 + - catenaXId: urn:uuid:d9bec1c6-e47c-4d18-ba41-0a5fe8b7f447 + linkedItem: + assembledOn: 2022-02-03T14:48:54.709Z + childCatenaXId: urn:uuid:a45a2246-f6e1-42da-b47d-5c3b58ed62e9 + hasAlternatives: false + lastModifiedOn: 2022-02-03T14:48:54.709Z + lifecycleContext: asBuilt + quantity: + measurementUnit: + datatypeURI: urn:bamm:io.openmanufacturing:meta-model:1.0.0#piece + lexicalValue: piece + quantityNumber: 1.0 shells: - - contractAgreementId: f253718e-a270-4367-901b-9d50d9bd8462 - payload: - description: - - language: en - text: The shell for a vehicle - globalAssetId: urn:uuid:a45a2246-f6e1-42da-b47d-5c3b58ed62e9 - id: urn:uuid:882fc530-b69b-4707-95f6-5dbc5e9baaa8 - idShort: future concept x - specificAssetIds: - - name: engineserialid - value: "12309481209312" - submodelDescriptors: - - description: - - language: en - text: Provides base vehicle information - endpoints: - - interface: HTTP - protocolInformation: - endpointProtocol: HTTPS - endpointProtocolVersion: - - "1.0" - href: https://catena-x.net/vehicle/basedetails/ - subprotocol: DSP - subprotocolBody: id=urn:uuid:c8159379-4613-48b8-ad52-6baed7afe923;dspEndpoint=https://irs-provider-controlplane3.dev.demo.catena-x.net - subprotocolBodyEncoding: plain - id: urn:uuid:5d25a897-6571-4800-b98c-a3352fbf996d - idShort: SingleLevelBomAsPlanned - semanticId: - keys: - - type: ExternalReference - value: urn:samm:io.catenax.single_level_bom_as_built:3.0.0#SingleLevelBomAsBuilt - type: ModelReference - - description: - - language: en - text: Provides base vehicle information - endpoints: - - interface: HTTP - protocolInformation: - endpointProtocol: HTTPS - endpointProtocolVersion: - - "1.0" - href: https://catena-x.net/vehicle/partdetails/ - subprotocol: DSP - subprotocolBody: id=urn:uuid:c8159379-4613-48b8-ad52-6baed7afe923;dspEndpoint=https://irs-provider-controlplane3.dev.demo.catena-x.net - subprotocolBodyEncoding: plain - id: urn:uuid:dae4d249-6d66-4818-b576-bf52f3b9ae90 - idShort: vehicle part details - semanticId: - keys: - - type: Submodel - value: urn:bamm:io.catenax.vehicle:0.1.1#PartDetails - type: ModelReference + - contractAgreementId: f253718e-a270-4367-901b-9d50d9bd8462 + payload: + description: + - language: en + text: The shell for a vehicle + globalAssetId: urn:uuid:a45a2246-f6e1-42da-b47d-5c3b58ed62e9 + id: urn:uuid:882fc530-b69b-4707-95f6-5dbc5e9baaa8 + idShort: future concept x + specificAssetIds: + - name: engineserialid + value: "12309481209312" + submodelDescriptors: + - description: + - language: en + text: Provides base vehicle information + endpoints: + - interface: HTTP + protocolInformation: + endpointProtocol: HTTPS + endpointProtocolVersion: + - "1.0" + href: https://catena-x.net/vehicle/basedetails/ + subprotocol: DSP + subprotocolBody: id=urn:uuid:c8159379-4613-48b8-ad52-6baed7afe923;dspEndpoint=https://irs-provider-controlplane3.dev.demo.catena-x.net + subprotocolBodyEncoding: plain + id: urn:uuid:5d25a897-6571-4800-b98c-a3352fbf996d + idShort: SingleLevelBomAsPlanned + semanticId: + keys: + - type: ExternalReference + value: urn:samm:io.catenax.single_level_bom_as_built:3.0.0#SingleLevelBomAsBuilt + type: ModelReference + - description: + - language: en + text: Provides base vehicle information + endpoints: + - interface: HTTP + protocolInformation: + endpointProtocol: HTTPS + endpointProtocolVersion: + - "1.0" + href: https://catena-x.net/vehicle/partdetails/ + subprotocol: DSP + subprotocolBody: id=urn:uuid:c8159379-4613-48b8-ad52-6baed7afe923;dspEndpoint=https://irs-provider-controlplane3.dev.demo.catena-x.net + subprotocolBodyEncoding: plain + id: urn:uuid:dae4d249-6d66-4818-b576-bf52f3b9ae90 + idShort: vehicle part details + semanticId: + keys: + - type: Submodel + value: urn:bamm:io.catenax.vehicle:0.1.1#PartDetails + type: ModelReference submodels: - - aspectType: supply_chain_impacted - contractAgreementId: f253718e-a270-4367-901b-9d50d9bd8462 - identification: urn:uuid:fc784d2a-5506-4e61-8e34-21600f8cdeff - payload: - supplyChainImpacted: "YES" + - aspectType: supply_chain_impacted + contractAgreementId: f253718e-a270-4367-901b-9d50d9bd8462 + identification: urn:uuid:fc784d2a-5506-4e61-8e34-21600f8cdeff + payload: + supplyChainImpacted: "YES" tombstones: - - catenaXId: urn:uuid:6c311d29-5753-46d4-b32c-19b918ea93b0 - endpointURL: https://catena-x.net/vehicle/partdetails/ - processingError: - errorDetail: Details to reason of failure - lastAttempt: 2022-02-03T14:48:54.709Z - processStep: SchemaValidation - retryCounter: 0 + - catenaXId: urn:uuid:6c311d29-5753-46d4-b32c-19b918ea93b0 + endpointURL: https://catena-x.net/vehicle/partdetails/ + processingError: + errorDetail: Details to reason of failure + lastAttempt: 2022-02-03T14:48:54.709Z + processStep: SchemaValidation + retryCounter: 0 complete-job-list-processing-state: value: content: - - completedOn: 2022-02-03T14:48:54.709Z - id: 6c311d29-5753-46d4-b32c-19b918ea93b0 - startedOn: 2022-02-03T14:48:54.709Z - state: COMPLETED + - completedOn: 2022-02-03T14:48:54.709Z + id: 6c311d29-5753-46d4-b32c-19b918ea93b0 + startedOn: 2022-02-03T14:48:54.709Z + state: COMPLETED pageCount: 1 pageNumber: 0 pageSize: 10 @@ -1268,8 +1253,8 @@ components: complete-job-result: value: bpns: - - manufacturerId: BPNL00000003AYRE - manufacturerName: OEM A + - manufacturerId: BPNL00000003AYRE + manufacturerName: OEM A job: completedOn: 2022-02-03T14:48:54.709Z createdOn: 2022-02-03T14:48:54.709Z @@ -1282,8 +1267,8 @@ components: lastModifiedOn: 2022-02-03T14:48:54.709Z parameter: aspects: - - urn:samm:io.catenax.single_level_bom_as_built:3.0.0#SingleLevelBomAsBuilt - - urn:samm:io.catenax.serial_part:3.0.0#SerialPart + - urn:samm:io.catenax.single_level_bom_as_built:3.0.0#SingleLevelBomAsBuilt + - urn:samm:io.catenax.serial_part:3.0.0#SerialPart auditContractNegotiation: false bomLifecycle: asBuilt collectAspects: false @@ -1298,134 +1283,134 @@ components: failed: 0 running: 0 relationships: - - catenaXId: urn:uuid:d9bec1c6-e47c-4d18-ba41-0a5fe8b7f447 - linkedItem: - assembledOn: 2022-02-03T14:48:54.709Z - childCatenaXId: urn:uuid:a45a2246-f6e1-42da-b47d-5c3b58ed62e9 - hasAlternatives: false - lastModifiedOn: 2022-02-03T14:48:54.709Z - lifecycleContext: asBuilt - quantity: - measurementUnit: - datatypeURI: urn:bamm:io.openmanufacturing:meta-model:1.0.0#piece - lexicalValue: piece - quantityNumber: 1.0 - shells: - - contractAgreementId: f253718e-a270-4367-901b-9d50d9bd8462 - payload: - description: - - language: en - text: The shell for a vehicle - globalAssetId: urn:uuid:a45a2246-f6e1-42da-b47d-5c3b58ed62e9 - id: urn:uuid:882fc530-b69b-4707-95f6-5dbc5e9baaa8 - idShort: future concept x - specificAssetIds: - - name: engineserialid - value: "12309481209312" - submodelDescriptors: - - description: - - language: en - text: Provides base vehicle information - endpoints: - - interface: HTTP - protocolInformation: - endpointProtocol: HTTPS - endpointProtocolVersion: - - "1.0" - href: https://catena-x.net/vehicle/basedetails/ - subprotocol: DSP - subprotocolBody: id=urn:uuid:c8159379-4613-48b8-ad52-6baed7afe923;dspEndpoint=https://irs-provider-controlplane3.dev.demo.catena-x.net - subprotocolBodyEncoding: plain - id: urn:uuid:5d25a897-6571-4800-b98c-a3352fbf996d - idShort: SingleLevelBomAsPlanned - semanticId: - keys: - - type: ExternalReference - value: urn:samm:io.catenax.single_level_bom_as_built:3.0.0#SingleLevelBomAsBuilt - type: ModelReference - - description: - - language: en - text: Provides base vehicle information - endpoints: - - interface: HTTP - protocolInformation: - endpointProtocol: HTTPS - endpointProtocolVersion: - - "1.0" - href: https://catena-x.net/vehicle/partdetails/ - subprotocol: DSP - subprotocolBody: id=urn:uuid:c8159379-4613-48b8-ad52-6baed7afe923;dspEndpoint=https://irs-provider-controlplane3.dev.demo.catena-x.net - subprotocolBodyEncoding: plain - id: urn:uuid:dae4d249-6d66-4818-b576-bf52f3b9ae90 - idShort: vehicle part details - semanticId: - keys: - - type: Submodel - value: urn:bamm:io.catenax.vehicle:0.1.1#PartDetails - type: ModelReference - submodels: - - aspectType: urn:samm:io.catenax.single_level_bom_as_built:3.0.0#SingleLevelBomAsBuilt - contractAgreementId: f253718e-a270-4367-901b-9d50d9bd8462 - identification: urn:uuid:fc784d2a-5506-4e61-8e34-21600f8cdeff - payload: - catenaXId: urn:uuid:d9bec1c6-e47c-4d18-ba41-0a5fe8b7f447 - childItems: - - businessPartner: BPNL00012345aNXY - catenaXId: urn:uuid:d9bec1c6-e47c-4d18-ba41-0a5fe8b7f447 - createdOn: 2022-02-03T14:48:54.709Z + - catenaXId: urn:uuid:d9bec1c6-e47c-4d18-ba41-0a5fe8b7f447 + linkedItem: + assembledOn: 2022-02-03T14:48:54.709Z + childCatenaXId: urn:uuid:a45a2246-f6e1-42da-b47d-5c3b58ed62e9 hasAlternatives: false lastModifiedOn: 2022-02-03T14:48:54.709Z + lifecycleContext: asBuilt quantity: - unit: unit:piece - value: 20.0 + measurementUnit: + datatypeURI: urn:bamm:io.openmanufacturing:meta-model:1.0.0#piece + lexicalValue: piece + quantityNumber: 1.0 + shells: + - contractAgreementId: f253718e-a270-4367-901b-9d50d9bd8462 + payload: + description: + - language: en + text: The shell for a vehicle + globalAssetId: urn:uuid:a45a2246-f6e1-42da-b47d-5c3b58ed62e9 + id: urn:uuid:882fc530-b69b-4707-95f6-5dbc5e9baaa8 + idShort: future concept x + specificAssetIds: + - name: engineserialid + value: "12309481209312" + submodelDescriptors: + - description: + - language: en + text: Provides base vehicle information + endpoints: + - interface: HTTP + protocolInformation: + endpointProtocol: HTTPS + endpointProtocolVersion: + - "1.0" + href: https://catena-x.net/vehicle/basedetails/ + subprotocol: DSP + subprotocolBody: id=urn:uuid:c8159379-4613-48b8-ad52-6baed7afe923;dspEndpoint=https://irs-provider-controlplane3.dev.demo.catena-x.net + subprotocolBodyEncoding: plain + id: urn:uuid:5d25a897-6571-4800-b98c-a3352fbf996d + idShort: SingleLevelBomAsPlanned + semanticId: + keys: + - type: ExternalReference + value: urn:samm:io.catenax.single_level_bom_as_built:3.0.0#SingleLevelBomAsBuilt + type: ModelReference + - description: + - language: en + text: Provides base vehicle information + endpoints: + - interface: HTTP + protocolInformation: + endpointProtocol: HTTPS + endpointProtocolVersion: + - "1.0" + href: https://catena-x.net/vehicle/partdetails/ + subprotocol: DSP + subprotocolBody: id=urn:uuid:c8159379-4613-48b8-ad52-6baed7afe923;dspEndpoint=https://irs-provider-controlplane3.dev.demo.catena-x.net + subprotocolBodyEncoding: plain + id: urn:uuid:dae4d249-6d66-4818-b576-bf52f3b9ae90 + idShort: vehicle part details + semanticId: + keys: + - type: Submodel + value: urn:bamm:io.catenax.vehicle:0.1.1#PartDetails + type: ModelReference + submodels: + - aspectType: urn:samm:io.catenax.single_level_bom_as_built:3.0.0#SingleLevelBomAsBuilt + contractAgreementId: f253718e-a270-4367-901b-9d50d9bd8462 + identification: urn:uuid:fc784d2a-5506-4e61-8e34-21600f8cdeff + payload: + catenaXId: urn:uuid:d9bec1c6-e47c-4d18-ba41-0a5fe8b7f447 + childItems: + - businessPartner: BPNL00012345aNXY + catenaXId: urn:uuid:d9bec1c6-e47c-4d18-ba41-0a5fe8b7f447 + createdOn: 2022-02-03T14:48:54.709Z + hasAlternatives: false + lastModifiedOn: 2022-02-03T14:48:54.709Z + quantity: + unit: unit:piece + value: 20.0 tombstones: - - catenaXId: urn:uuid:6c311d29-5753-46d4-b32c-19b918ea93b0 - endpointURL: https://catena-x.net/vehicle/partdetails/ - processingError: - errorDetail: Details to reason of failure - lastAttempt: 2022-02-03T14:48:54.709Z - processStep: SchemaValidation - retryCounter: 0 + - catenaXId: urn:uuid:6c311d29-5753-46d4-b32c-19b918ea93b0 + endpointURL: https://catena-x.net/vehicle/partdetails/ + processingError: + errorDetail: Details to reason of failure + lastAttempt: 2022-02-03T14:48:54.709Z + processStep: SchemaValidation + retryCounter: 0 complete-order-result: value: batchChecksum: 1 batches: - - batchId: f253718e-a270-4367-901b-9d50d9bd8462 - batchNumber: 1 - batchProcessingState: PARTIAL - batchUrl: https://../irs/orders/f253718e-a270-4367-901b-9d50d9bd8462/batches/f253718e-a270-4367-901b-9d50d9bd8462 - jobsInBatchChecksum: 1 + - batchId: f253718e-a270-4367-901b-9d50d9bd8462 + batchNumber: 1 + batchProcessingState: PARTIAL + batchUrl: https://../irs/orders/f253718e-a270-4367-901b-9d50d9bd8462/batches/f253718e-a270-4367-901b-9d50d9bd8462 + jobsInBatchChecksum: 1 orderId: f253718e-a270-4367-901b-9d50d9bd8462 state: COMPLETED error-response-400: value: error: Bad request messages: - - BadRequestException + - BadRequestException statusCode: 400 BAD_REQUEST error-response-401: value: error: Unauthorized messages: - - UnauthorizedException + - UnauthorizedException statusCode: 401 UNAUTHORIZED error-response-403: value: error: Forbidden messages: - - ForbiddenException + - ForbiddenException statusCode: 403 FORBIDDEN error-response-404: value: error: Not found messages: - - NotFoundException + - NotFoundException statusCode: 404 NOT_FOUND error-response-500: value: error: Internal Server Error messages: - - InternalServerError + - InternalServerError statusCode: 500 INTERNAL_SERVER_ERROR failed-job-result: value: @@ -1441,8 +1426,8 @@ components: lastModifiedOn: 2022-02-03T14:48:54.709Z parameter: aspects: - - urn:samm:io.catenax.single_level_bom_as_built:3.0.0#SingleLevelBomAsBuilt - - urn:samm:io.catenax.serial_part:3.0.0#SerialPart + - urn:samm:io.catenax.single_level_bom_as_built:3.0.0#SingleLevelBomAsBuilt + - urn:samm:io.catenax.serial_part:3.0.0#SerialPart auditContractNegotiation: false bomLifecycle: asBuilt collectAspects: false @@ -1465,8 +1450,8 @@ components: job-result-without-uncompleted-result-tree: value: bpns: - - manufacturerId: BPNL00000003AYRE - manufacturerName: OEM A + - manufacturerId: BPNL00000003AYRE + manufacturerName: OEM A job: completedOn: 2022-02-03T14:48:54.709Z createdOn: 2022-02-03T14:48:54.709Z @@ -1479,8 +1464,8 @@ components: lastModifiedOn: 2022-02-03T14:48:54.709Z parameter: aspects: - - urn:samm:io.catenax.single_level_bom_as_built:3.0.0#SingleLevelBomAsBuilt - - urn:samm:io.catenax.serial_part:3.0.0#SerialPart + - urn:samm:io.catenax.single_level_bom_as_built:3.0.0#SingleLevelBomAsBuilt + - urn:samm:io.catenax.serial_part:3.0.0#SerialPart auditContractNegotiation: false bomLifecycle: asBuilt collectAspects: false @@ -1495,94 +1480,94 @@ components: failed: 0 running: 0 relationships: - - catenaXId: urn:uuid:d9bec1c6-e47c-4d18-ba41-0a5fe8b7f447 - linkedItem: - assembledOn: 2022-02-03T14:48:54.709Z - childCatenaXId: urn:uuid:a45a2246-f6e1-42da-b47d-5c3b58ed62e9 - hasAlternatives: false - lastModifiedOn: 2022-02-03T14:48:54.709Z - lifecycleContext: asBuilt - quantity: - measurementUnit: - datatypeURI: urn:bamm:io.openmanufacturing:meta-model:1.0.0#piece - lexicalValue: piece - quantityNumber: 1.0 - shells: - - contractAgreementId: f253718e-a270-4367-901b-9d50d9bd8462 - payload: - description: - - language: en - text: The shell for a vehicle - globalAssetId: urn:uuid:a45a2246-f6e1-42da-b47d-5c3b58ed62e9 - id: urn:uuid:882fc530-b69b-4707-95f6-5dbc5e9baaa8 - idShort: future concept x - specificAssetIds: - - name: engineserialid - value: "12309481209312" - submodelDescriptors: - - description: - - language: en - text: Provides base vehicle information - endpoints: - - interface: HTTP - protocolInformation: - endpointProtocol: HTTPS - endpointProtocolVersion: - - "1.0" - href: https://catena-x.net/vehicle/basedetails/ - subprotocol: DSP - subprotocolBody: id=urn:uuid:c8159379-4613-48b8-ad52-6baed7afe923;dspEndpoint=https://irs-provider-controlplane3.dev.demo.catena-x.net - subprotocolBodyEncoding: plain - id: urn:uuid:5d25a897-6571-4800-b98c-a3352fbf996d - idShort: SingleLevelBomAsPlanned - semanticId: - keys: - - type: ExternalReference - value: urn:samm:io.catenax.single_level_bom_as_built:3.0.0#SingleLevelBomAsBuilt - type: ModelReference - - description: - - language: en - text: Provides base vehicle information - endpoints: - - interface: HTTP - protocolInformation: - endpointProtocol: HTTPS - endpointProtocolVersion: - - "1.0" - href: https://catena-x.net/vehicle/partdetails/ - subprotocol: DSP - subprotocolBody: id=urn:uuid:c8159379-4613-48b8-ad52-6baed7afe923;dspEndpoint=https://irs-provider-controlplane3.dev.demo.catena-x.net - subprotocolBodyEncoding: plain - id: urn:uuid:dae4d249-6d66-4818-b576-bf52f3b9ae90 - idShort: vehicle part details - semanticId: - keys: - - type: Submodel - value: urn:bamm:io.catenax.vehicle:0.1.1#PartDetails - type: ModelReference - submodels: - - aspectType: urn:samm:io.catenax.single_level_bom_as_built:3.0.0#SingleLevelBomAsBuilt - contractAgreementId: f253718e-a270-4367-901b-9d50d9bd8462 - identification: urn:uuid:fc784d2a-5506-4e61-8e34-21600f8cdeff - payload: - catenaXId: urn:uuid:d9bec1c6-e47c-4d18-ba41-0a5fe8b7f447 - childItems: - - businessPartner: BPNL00012345aNXY - catenaXId: urn:uuid:d9bec1c6-e47c-4d18-ba41-0a5fe8b7f447 - createdOn: 2022-02-03T14:48:54.709Z + - catenaXId: urn:uuid:d9bec1c6-e47c-4d18-ba41-0a5fe8b7f447 + linkedItem: + assembledOn: 2022-02-03T14:48:54.709Z + childCatenaXId: urn:uuid:a45a2246-f6e1-42da-b47d-5c3b58ed62e9 hasAlternatives: false lastModifiedOn: 2022-02-03T14:48:54.709Z + lifecycleContext: asBuilt quantity: - unit: unit:piece - value: 20.0 + measurementUnit: + datatypeURI: urn:bamm:io.openmanufacturing:meta-model:1.0.0#piece + lexicalValue: piece + quantityNumber: 1.0 + shells: + - contractAgreementId: f253718e-a270-4367-901b-9d50d9bd8462 + payload: + description: + - language: en + text: The shell for a vehicle + globalAssetId: urn:uuid:a45a2246-f6e1-42da-b47d-5c3b58ed62e9 + id: urn:uuid:882fc530-b69b-4707-95f6-5dbc5e9baaa8 + idShort: future concept x + specificAssetIds: + - name: engineserialid + value: "12309481209312" + submodelDescriptors: + - description: + - language: en + text: Provides base vehicle information + endpoints: + - interface: HTTP + protocolInformation: + endpointProtocol: HTTPS + endpointProtocolVersion: + - "1.0" + href: https://catena-x.net/vehicle/basedetails/ + subprotocol: DSP + subprotocolBody: id=urn:uuid:c8159379-4613-48b8-ad52-6baed7afe923;dspEndpoint=https://irs-provider-controlplane3.dev.demo.catena-x.net + subprotocolBodyEncoding: plain + id: urn:uuid:5d25a897-6571-4800-b98c-a3352fbf996d + idShort: SingleLevelBomAsPlanned + semanticId: + keys: + - type: ExternalReference + value: urn:samm:io.catenax.single_level_bom_as_built:3.0.0#SingleLevelBomAsBuilt + type: ModelReference + - description: + - language: en + text: Provides base vehicle information + endpoints: + - interface: HTTP + protocolInformation: + endpointProtocol: HTTPS + endpointProtocolVersion: + - "1.0" + href: https://catena-x.net/vehicle/partdetails/ + subprotocol: DSP + subprotocolBody: id=urn:uuid:c8159379-4613-48b8-ad52-6baed7afe923;dspEndpoint=https://irs-provider-controlplane3.dev.demo.catena-x.net + subprotocolBodyEncoding: plain + id: urn:uuid:dae4d249-6d66-4818-b576-bf52f3b9ae90 + idShort: vehicle part details + semanticId: + keys: + - type: Submodel + value: urn:bamm:io.catenax.vehicle:0.1.1#PartDetails + type: ModelReference + submodels: + - aspectType: urn:samm:io.catenax.single_level_bom_as_built:3.0.0#SingleLevelBomAsBuilt + contractAgreementId: f253718e-a270-4367-901b-9d50d9bd8462 + identification: urn:uuid:fc784d2a-5506-4e61-8e34-21600f8cdeff + payload: + catenaXId: urn:uuid:d9bec1c6-e47c-4d18-ba41-0a5fe8b7f447 + childItems: + - businessPartner: BPNL00012345aNXY + catenaXId: urn:uuid:d9bec1c6-e47c-4d18-ba41-0a5fe8b7f447 + createdOn: 2022-02-03T14:48:54.709Z + hasAlternatives: false + lastModifiedOn: 2022-02-03T14:48:54.709Z + quantity: + unit: unit:piece + value: 20.0 tombstones: - - catenaXId: urn:uuid:6c311d29-5753-46d4-b32c-19b918ea93b0 - endpointURL: https://catena-x.net/vehicle/partdetails/ - processingError: - errorDetail: Details to reason of failure - lastAttempt: 2022-02-03T14:48:54.709Z - processStep: SchemaValidation - retryCounter: 0 + - catenaXId: urn:uuid:6c311d29-5753-46d4-b32c-19b918ea93b0 + endpointURL: https://catena-x.net/vehicle/partdetails/ + processingError: + errorDetail: Details to reason of failure + lastAttempt: 2022-02-03T14:48:54.709Z + processStep: SchemaValidation + retryCounter: 0 partial-job-result: value: bpns: [] @@ -1598,8 +1583,8 @@ components: lastModifiedOn: 2022-02-03T14:48:54.709Z parameter: aspects: - - urn:samm:io.catenax.single_level_bom_as_built:3.0.0#SingleLevelBomAsBuilt - - urn:samm:io.catenax.serial_part:3.0.0#SerialPart + - urn:samm:io.catenax.single_level_bom_as_built:3.0.0#SingleLevelBomAsBuilt + - urn:samm:io.catenax.serial_part:3.0.0#SerialPart auditContractNegotiation: false bomLifecycle: asBuilt collectAspects: false @@ -1720,11 +1705,7 @@ components: type: object additionalProperties: false description: BatchOrderAck Payload Response. - example: "{\"batchChecksum\"=1, \"batches\"=[{\"batchId\"=\"f253718e-a270-4367-901b-9d50d9bd8462\"\ - , \"batchNumber\"=1, \"batchProcessingState\"=\"PARTIAL\", \"batchUrl\"=\"\ - https://../irs/orders/f253718e-a270-4367-901b-9d50d9bd8462/batches/f253718e-a270-4367-901b-9d50d9bd8462\"\ - , \"jobsInBatchChecksum\"=1}], \"orderId\"=\"f253718e-a270-4367-901b-9d50d9bd8462\"\ - , \"state\"=\"COMPLETED\"}" + example: "{\"batchChecksum\"=1, \"batches\"=[{\"batchId\"=\"f253718e-a270-4367-901b-9d50d9bd8462\", \"batchNumber\"=1, \"batchProcessingState\"=\"PARTIAL\", \"batchUrl\"=\"https://../irs/orders/f253718e-a270-4367-901b-9d50d9bd8462/batches/f253718e-a270-4367-901b-9d50d9bd8462\", \"jobsInBatchChecksum\"=1}], \"orderId\"=\"f253718e-a270-4367-901b-9d50d9bd8462\", \"state\"=\"COMPLETED\"}" properties: batchChecksum: type: integer @@ -1747,21 +1728,16 @@ components: type: string description: The state of the order. enum: - - INITIALIZED - - COMPLETED - - PROCESSING - - PARTIAL - - ERROR + - INITIALIZED + - COMPLETED + - PROCESSING + - PARTIAL + - ERROR BatchResponse: type: object additionalProperties: false description: Batch model. - example: "{\"batchId\"=\"f253718e-a270-4367-901b-9d50d9bd8462\", \"batchNumber\"\ - =1, \"batchProcessingState\"=\"COMPLETED\", \"batchTotal\"=1, \"completedOn\"\ - =\"2022-02-03T14:48:54.709Z\", \"jobs\"=[{\"completedOn\"=\"2022-02-03T14:48:54.709Z\"\ - , \"id\"=\"6c311d29-5753-46d4-b32c-19b918ea93b0\", \"startedOn\"=\"2022-02-03T14:48:54.709Z\"\ - , \"state\"=\"COMPLETED\"}], \"jobsInBatchChecksum\"=1, \"orderId\"=\"f253718e-a270-4367-901b-9d50d9bd8462\"\ - , \"startedOn\"=\"2022-02-03T14:48:54.709Z\", \"totalJobs\"=1}" + example: "{\"batchId\"=\"f253718e-a270-4367-901b-9d50d9bd8462\", \"batchNumber\"=1, \"batchProcessingState\"=\"COMPLETED\", \"batchTotal\"=1, \"completedOn\"=\"2022-02-03T14:48:54.709Z\", \"jobs\"=[{\"completedOn\"=\"2022-02-03T14:48:54.709Z\", \"id\"=\"6c311d29-5753-46d4-b32c-19b918ea93b0\", \"startedOn\"=\"2022-02-03T14:48:54.709Z\", \"state\"=\"COMPLETED\"}], \"jobsInBatchChecksum\"=1, \"orderId\"=\"f253718e-a270-4367-901b-9d50d9bd8462\", \"startedOn\"=\"2022-02-03T14:48:54.709Z\", \"totalJobs\"=1}" properties: batchId: type: string @@ -1778,11 +1754,11 @@ components: type: string description: The state of the batch. enum: - - INITIALIZED - - COMPLETED - - PROCESSING - - PARTIAL - - ERROR + - INITIALIZED + - COMPLETED + - PROCESSING + - PARTIAL + - ERROR batchTotal: type: integer format: int32 @@ -1858,39 +1834,38 @@ components: policy: '@type': Policy odrl:permission: - - odrl:action: use - odrl:constraint: - odrl:and: - - odrl:leftOperand: Membership - odrl:operator: - '@id': odrl:eq - odrl:rightOperand: active - - odrl:leftOperand: PURPOSE - odrl:operator: - '@id': odrl:eq - odrl:rightOperand: ID 3.1 Trace + - odrl:action: use + odrl:constraint: + odrl:and: + - odrl:leftOperand: Membership + odrl:operator: + '@id': odrl:eq + odrl:rightOperand: active + - odrl:leftOperand: PURPOSE + odrl:operator: + '@id': odrl:eq + odrl:rightOperand: ID 3.1 Trace properties: empty: type: boolean valueType: type: string enum: - - ARRAY - - OBJECT - - STRING - - NUMBER - - "TRUE" - - "FALSE" - - "NULL" + - ARRAY + - OBJECT + - STRING + - NUMBER + - "TRUE" + - "FALSE" + - "NULL" validUntil: type: string format: date-time - description: Timestamp after which the policy will no longer be accepted - in negotiations. + description: Timestamp after which the policy will no longer be accepted in negotiations. example: 2025-12-12T23:59:59.999Z required: - - payload - - validUntil + - payload + - validUntil EdcNotificationHeader: type: object additionalProperties: false @@ -1913,10 +1888,10 @@ components: senderEdc: type: string required: - - notificationId - - notificationType - - recipientBpn - - senderBpn + - notificationId + - notificationType + - recipientBpn + - senderBpn EdcNotificationResponseNotificationContent: type: object additionalProperties: false @@ -1926,8 +1901,8 @@ components: header: $ref: '#/components/schemas/EdcNotificationHeader' required: - - content - - header + - content + - header Endpoint: type: object additionalProperties: false @@ -1955,75 +1930,75 @@ components: type: string description: Error code. enum: - - 100 CONTINUE - - 101 SWITCHING_PROTOCOLS - - 102 PROCESSING - - 103 EARLY_HINTS - - 103 CHECKPOINT - - 200 OK - - 201 CREATED - - 202 ACCEPTED - - 203 NON_AUTHORITATIVE_INFORMATION - - 204 NO_CONTENT - - 205 RESET_CONTENT - - 206 PARTIAL_CONTENT - - 207 MULTI_STATUS - - 208 ALREADY_REPORTED - - 226 IM_USED - - 300 MULTIPLE_CHOICES - - 301 MOVED_PERMANENTLY - - 302 FOUND - - 302 MOVED_TEMPORARILY - - 303 SEE_OTHER - - 304 NOT_MODIFIED - - 305 USE_PROXY - - 307 TEMPORARY_REDIRECT - - 308 PERMANENT_REDIRECT - - 400 BAD_REQUEST - - 401 UNAUTHORIZED - - 402 PAYMENT_REQUIRED - - 403 FORBIDDEN - - 404 NOT_FOUND - - 405 METHOD_NOT_ALLOWED - - 406 NOT_ACCEPTABLE - - 407 PROXY_AUTHENTICATION_REQUIRED - - 408 REQUEST_TIMEOUT - - 409 CONFLICT - - 410 GONE - - 411 LENGTH_REQUIRED - - 412 PRECONDITION_FAILED - - 413 PAYLOAD_TOO_LARGE - - 413 REQUEST_ENTITY_TOO_LARGE - - 414 URI_TOO_LONG - - 414 REQUEST_URI_TOO_LONG - - 415 UNSUPPORTED_MEDIA_TYPE - - 416 REQUESTED_RANGE_NOT_SATISFIABLE - - 417 EXPECTATION_FAILED - - 418 I_AM_A_TEAPOT - - 419 INSUFFICIENT_SPACE_ON_RESOURCE - - 420 METHOD_FAILURE - - 421 DESTINATION_LOCKED - - 422 UNPROCESSABLE_ENTITY - - 423 LOCKED - - 424 FAILED_DEPENDENCY - - 425 TOO_EARLY - - 426 UPGRADE_REQUIRED - - 428 PRECONDITION_REQUIRED - - 429 TOO_MANY_REQUESTS - - 431 REQUEST_HEADER_FIELDS_TOO_LARGE - - 451 UNAVAILABLE_FOR_LEGAL_REASONS - - 500 INTERNAL_SERVER_ERROR - - 501 NOT_IMPLEMENTED - - 502 BAD_GATEWAY - - 503 SERVICE_UNAVAILABLE - - 504 GATEWAY_TIMEOUT - - 505 HTTP_VERSION_NOT_SUPPORTED - - 506 VARIANT_ALSO_NEGOTIATES - - 507 INSUFFICIENT_STORAGE - - 508 LOOP_DETECTED - - 509 BANDWIDTH_LIMIT_EXCEEDED - - 510 NOT_EXTENDED - - 511 NETWORK_AUTHENTICATION_REQUIRED + - 100 CONTINUE + - 101 SWITCHING_PROTOCOLS + - 102 PROCESSING + - 103 EARLY_HINTS + - 103 CHECKPOINT + - 200 OK + - 201 CREATED + - 202 ACCEPTED + - 203 NON_AUTHORITATIVE_INFORMATION + - 204 NO_CONTENT + - 205 RESET_CONTENT + - 206 PARTIAL_CONTENT + - 207 MULTI_STATUS + - 208 ALREADY_REPORTED + - 226 IM_USED + - 300 MULTIPLE_CHOICES + - 301 MOVED_PERMANENTLY + - 302 FOUND + - 302 MOVED_TEMPORARILY + - 303 SEE_OTHER + - 304 NOT_MODIFIED + - 305 USE_PROXY + - 307 TEMPORARY_REDIRECT + - 308 PERMANENT_REDIRECT + - 400 BAD_REQUEST + - 401 UNAUTHORIZED + - 402 PAYMENT_REQUIRED + - 403 FORBIDDEN + - 404 NOT_FOUND + - 405 METHOD_NOT_ALLOWED + - 406 NOT_ACCEPTABLE + - 407 PROXY_AUTHENTICATION_REQUIRED + - 408 REQUEST_TIMEOUT + - 409 CONFLICT + - 410 GONE + - 411 LENGTH_REQUIRED + - 412 PRECONDITION_FAILED + - 413 PAYLOAD_TOO_LARGE + - 413 REQUEST_ENTITY_TOO_LARGE + - 414 URI_TOO_LONG + - 414 REQUEST_URI_TOO_LONG + - 415 UNSUPPORTED_MEDIA_TYPE + - 416 REQUESTED_RANGE_NOT_SATISFIABLE + - 417 EXPECTATION_FAILED + - 418 I_AM_A_TEAPOT + - 419 INSUFFICIENT_SPACE_ON_RESOURCE + - 420 METHOD_FAILURE + - 421 DESTINATION_LOCKED + - 422 UNPROCESSABLE_ENTITY + - 423 LOCKED + - 424 FAILED_DEPENDENCY + - 425 TOO_EARLY + - 426 UPGRADE_REQUIRED + - 428 PRECONDITION_REQUIRED + - 429 TOO_MANY_REQUESTS + - 431 REQUEST_HEADER_FIELDS_TOO_LARGE + - 451 UNAVAILABLE_FOR_LEGAL_REASONS + - 500 INTERNAL_SERVER_ERROR + - 501 NOT_IMPLEMENTED + - 502 BAD_GATEWAY + - 503 SERVICE_UNAVAILABLE + - 504 GATEWAY_TIMEOUT + - 505 HTTP_VERSION_NOT_SUPPORTED + - 506 VARIANT_ALSO_NEGOTIATES + - 507 INSUFFICIENT_STORAGE + - 508 LOOP_DETECTED + - 509 BANDWIDTH_LIMIT_EXCEEDED + - 510 NOT_EXTENDED + - 511 NETWORK_AUTHENTICATION_REQUIRED IdentifierKeyValuePair: type: object additionalProperties: false @@ -2083,20 +2058,20 @@ components: state: type: string enum: - - UNSAVED - - INITIAL - - RUNNING - - TRANSFERS_FINISHED - - COMPLETED - - CANCELED - - ERROR + - UNSAVED + - INITIAL + - RUNNING + - TRANSFERS_FINISHED + - COMPLETED + - CANCELED + - ERROR example: COMPLETED summary: $ref: '#/components/schemas/Summary' required: - - globalAssetId - - id - - state + - globalAssetId + - id + - state JobErrorDetails: type: object additionalProperties: false @@ -2142,12 +2117,11 @@ components: example: false bomLifecycle: type: string - description: The lifecycle context in which the child part was assembled - into the parent part. + description: The lifecycle context in which the child part was assembled into the parent part. enum: - - asBuilt - - asPlanned - - asSpecified + - asBuilt + - asPlanned + - asSpecified example: asBuilt bpn: type: string @@ -2168,8 +2142,8 @@ components: type: string description: Item graph traversal direction. enum: - - upward - - downward + - upward + - downward example: upward lookupBPNs: type: boolean @@ -2190,13 +2164,13 @@ components: state: type: string enum: - - UNSAVED - - INITIAL - - RUNNING - - TRANSFERS_FINISHED - - COMPLETED - - CANCELED - - ERROR + - UNSAVED + - INITIAL + - RUNNING + - TRANSFERS_FINISHED + - COMPLETED + - CANCELED + - ERROR Jobs: type: object additionalProperties: false @@ -2234,8 +2208,7 @@ components: maxItems: 2147483647 tombstones: type: array - description: Collection of not resolvable endpoints as tombstones. Including - cause of error and endpoint URL. + description: Collection of not resolvable endpoints as tombstones. Including cause of error and endpoint URL. items: $ref: '#/components/schemas/Tombstone' maxItems: 2147483647 @@ -2251,28 +2224,28 @@ components: policy: '@type': Policy odrl:permission: - - odrl:action: use - odrl:constraint: - odrl:and: - - odrl:leftOperand: Membership - odrl:operator: - '@id': odrl:eq - odrl:rightOperand: active - - odrl:leftOperand: PURPOSE - odrl:operator: - '@id': odrl:eq - odrl:rightOperand: ID 3.1 Trace + - odrl:action: use + odrl:constraint: + odrl:and: + - odrl:leftOperand: Membership + odrl:operator: + '@id': odrl:eq + odrl:rightOperand: active + - odrl:leftOperand: PURPOSE + odrl:operator: + '@id': odrl:eq + odrl:rightOperand: ID 3.1 Trace properties: valueType: type: string enum: - - ARRAY - - OBJECT - - STRING - - NUMBER - - "TRUE" - - "FALSE" - - "NULL" + - ARRAY + - OBJECT + - STRING + - NUMBER + - "TRUE" + - "FALSE" + - "NULL" LangString: type: object additionalProperties: false @@ -2286,8 +2259,7 @@ components: LinkedItem: type: object additionalProperties: false - description: Set of child parts the parent object is assembled by (one structural - level down). + description: Set of child parts the parent object is assembled by (one structural level down). properties: assembledOn: type: string @@ -2303,8 +2275,7 @@ components: pattern: "^urn:uuid:[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$" hasAlternatives: type: boolean - description: Expresses whether the part is built-in or whether it is one - of several options. + description: Expresses whether the part is built-in or whether it is one of several options. lastModifiedOn: type: string format: date-time @@ -2312,12 +2283,11 @@ components: example: 2022-02-03T14:48:54.709Z lifecycleContext: type: string - description: The lifecycle context in which the child part was assembled - into the parent part. + description: The lifecycle context in which the child part was assembled into the parent part. enum: - - asBuilt - - asPlanned - - asSpecified + - asBuilt + - asPlanned + - asSpecified example: asBuilt quantity: $ref: '#/components/schemas/Quantity' @@ -2334,9 +2304,7 @@ components: PageResult: type: object additionalProperties: false - example: "{\"content\"=[{\"completedOn\"=\"test\", \"id\"=\"046b6c7f-0b8a-43b9-b35d-6489e6daee91\"\ - , \"startedOn\"=\"2000-01-23T04:56:07.000+00:00\", \"state\"=\"UNSAVED\"}],\ - \ \"pageCount\"=0, \"pageNumber\"=6, \"pageSize\"=1, \"totalElements\"=5}" + example: "{\"content\"=[{\"completedOn\"=\"test\", \"id\"=\"046b6c7f-0b8a-43b9-b35d-6489e6daee91\", \"startedOn\"=\"2000-01-23T04:56:07.000+00:00\", \"state\"=\"UNSAVED\"}], \"pageCount\"=0, \"pageNumber\"=6, \"pageSize\"=1, \"totalElements\"=5}" properties: content: type: array @@ -2357,8 +2325,7 @@ components: PartChainIdentificationKey: type: object additionalProperties: false - description: Key object contains required attributes for identify part chain - entry node. + description: Key object contains required attributes for identify part chain entry node. properties: bpn: type: string @@ -2374,8 +2341,8 @@ components: minLength: 45 pattern: "^urn:uuid:[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$" required: - - bpn - - globalAssetId + - bpn + - globalAssetId ProcessingError: type: object additionalProperties: false @@ -2388,12 +2355,12 @@ components: processStep: type: string enum: - - SubmodelRequest - - DigitalTwinRequest - - SchemaValidation - - SchemaRequest - - UsagePolicyValidation - - EssValidation + - SubmodelRequest + - DigitalTwinRequest + - SchemaValidation + - SchemaRequest + - UsagePolicyValidation + - EssValidation retryCounter: type: integer format: int32 @@ -2409,7 +2376,7 @@ components: endpointProtocolVersion: type: array example: - - "1.0" + - "1.0" items: type: string href: @@ -2457,10 +2424,9 @@ components: properties: aspects: type: array - description: List of aspect names that will be collected if \ - flag is set to true. + description: List of aspect names that will be collected if \ flag is set to true. example: - - urn:samm:io.catenax.single_level_bom_as_built:3.0.0#SingleLevelBomAsBuilt + - urn:samm:io.catenax.single_level_bom_as_built:3.0.0#SingleLevelBomAsBuilt items: type: string pattern: "^(urn:[bs]amm:.*\\d\\.\\d\\.\\d)?(#)?(\\w+)?$" @@ -2477,32 +2443,27 @@ components: type: string description: The strategy how the batch is processed internally in IRS. enum: - - PRESERVE_BATCH_JOB_ORDER - - PRESERVE_JOB_ORDER - - PRESERVE_BATCH_ORDER + - PRESERVE_BATCH_JOB_ORDER + - PRESERVE_JOB_ORDER + - PRESERVE_BATCH_ORDER bomLifecycle: type: string - description: The lifecycle context in which the child part was assembled - into the parent part. + description: The lifecycle context in which the child part was assembled into the parent part. enum: - - asBuilt - - asPlanned - - asSpecified + - asBuilt + - asPlanned + - asSpecified callbackUrl: type: string - description: "Callback url to notify requestor when job processing is finished.\ - \ There are four uri variable placeholders that can be used: orderId,\ - \ batchId, orderState and batchState." + description: "Callback url to notify requestor when job processing is finished. There are four uri variable placeholders that can be used: orderId, batchId, orderState and batchState." example: "https://hostname.com/callback?orderId={orderId}&batchId={batchId}&orderState={orderState}&batchState={batchState}" collectAspects: type: boolean - description: Flag to specify whether aspects should be requested and collected. - Default is false. + description: Flag to specify whether aspects should be requested and collected. Default is false. depth: type: integer format: int32 - description: Max depth of the item graph returned. If no depth is set item - graph with max depth is returned. + description: Max depth of the item graph returned. If no depth is set item graph with max depth is returned. maximum: 100 minimum: 1 direction: @@ -2510,14 +2471,13 @@ components: default: downward description: Item graph traversal direction. enum: - - upward - - downward + - upward + - downward jobTimeout: type: integer format: int32 default: 3600 - description: Timeout in seconds for each job processing inside the complete - order. + description: Timeout in seconds for each job processing inside the complete order. maximum: 7200 minimum: 60 keys: @@ -2528,8 +2488,7 @@ components: lookupBPNs: type: boolean deprecated: true - description: Flag to specify whether BPNs should be collected and resolved - via the configured BPDM URL. Default is false. + description: Flag to specify whether BPNs should be collected and resolved via the configured BPDM URL. Default is false. timeout: type: integer format: int32 @@ -2538,12 +2497,11 @@ components: maximum: 86400 minimum: 60 required: - - keys + - keys RegisterBpnInvestigationBatchOrder: type: object additionalProperties: false - description: Request body for registering a new Batch Order for ESS Investigation - Job. + description: Request body for registering a new Batch Order for ESS Investigation Job. properties: batchSize: type: integer @@ -2556,22 +2514,19 @@ components: type: string description: The strategy how the batch is processed internally in IRS. enum: - - PRESERVE_BATCH_JOB_ORDER - - PRESERVE_JOB_ORDER - - PRESERVE_BATCH_ORDER + - PRESERVE_BATCH_JOB_ORDER + - PRESERVE_JOB_ORDER + - PRESERVE_BATCH_ORDER bomLifecycle: type: string - description: The lifecycle context in which the child part was assembled - into the parent part. + description: The lifecycle context in which the child part was assembled into the parent part. enum: - - asBuilt - - asPlanned - - asSpecified + - asBuilt + - asPlanned + - asSpecified callbackUrl: type: string - description: "Callback url to notify requestor when job processing is finished.\ - \ There are four uri variable placeholders that can be used: orderId,\ - \ batchId, orderState and batchState." + description: "Callback url to notify requestor when job processing is finished. There are four uri variable placeholders that can be used: orderId, batchId, orderState and batchState." example: "https://hostname.com/callback?orderId={orderId}&batchId={batchId}&orderState={orderState}&batchState={batchState}" incidentBPNSs: type: array @@ -2583,8 +2538,7 @@ components: type: integer format: int32 default: 3600 - description: Timeout in seconds for each job processing inside the complete - order. + description: Timeout in seconds for each job processing inside the complete order. maximum: 7200 minimum: 60 keys: @@ -2600,8 +2554,8 @@ components: maximum: 86400 minimum: 60 required: - - incidentBPNSs - - keys + - incidentBPNSs + - keys RegisterBpnInvestigationJob: type: object additionalProperties: false @@ -2609,24 +2563,21 @@ components: properties: bomLifecycle: type: string - description: The lifecycle context in which the child part was assembled - into the parent part. + description: The lifecycle context in which the child part was assembled into the parent part. enum: - - asBuilt - - asPlanned - - asSpecified + - asBuilt + - asPlanned + - asSpecified example: asPlanned callbackUrl: type: string - description: "Callback url to notify requestor when job processing is finished.\ - \ There are two uri variable placeholders that can be used: jobId and\ - \ jobState." + description: "Callback url to notify requestor when job processing is finished. There are two uri variable placeholders that can be used: jobId and jobState." example: "https://hostname.com/callback?jobId={jobId}&jobState={jobState}" incidentBPNSs: type: array description: Array of BPNS numbers. example: - - BPNS000000000DDD + - BPNS000000000DDD items: type: string pattern: "(BPN)[LSA][\\w\\d]{10}[\\w\\d]{2}" @@ -2635,8 +2586,8 @@ components: key: $ref: '#/components/schemas/PartChainIdentificationKey' required: - - incidentBPNSs - - key + - incidentBPNSs + - key RegisterJob: type: object additionalProperties: false @@ -2644,10 +2595,9 @@ components: properties: aspects: type: array - description: List of aspect names that will be collected if \ - flag is set to true. + description: List of aspect names that will be collected if \ flag is set to true. example: - - urn:samm:io.catenax.single_level_bom_as_built:3.0.0#SingleLevelBomAsBuilt + - urn:samm:io.catenax.single_level_bom_as_built:3.0.0#SingleLevelBomAsBuilt items: type: string pattern: "^(urn:[bs]amm:.*\\d\\.\\d\\.\\d)?(#)?(\\w+)?$" @@ -2655,31 +2605,25 @@ components: pattern: "^(urn:[bs]amm:.*\\d\\.\\d\\.\\d)?(#)?(\\w+)?$" auditContractNegotiation: type: boolean - description: "Flag enables and disables auditing, including provisioning\ - \ of ContractAgreementId inside submodels and shells objects. Default\ - \ is true." + description: "Flag enables and disables auditing, including provisioning of ContractAgreementId inside submodels and shells objects. Default is true." bomLifecycle: type: string - description: The lifecycle context in which the child part was assembled - into the parent part. + description: The lifecycle context in which the child part was assembled into the parent part. enum: - - asBuilt - - asPlanned - - asSpecified + - asBuilt + - asPlanned + - asSpecified callbackUrl: type: string - description: "Callback url to notify requestor when job processing is finished.\ - \ There are two uri variable placeholders that can be used: id and state." + description: "Callback url to notify requestor when job processing is finished. There are two uri variable placeholders that can be used: id and state." example: "https://hostname.com/callback?id={id}&state={state}" collectAspects: type: boolean - description: Flag to specify whether aspects should be requested and collected. - Default is false. + description: Flag to specify whether aspects should be requested and collected. Default is false. depth: type: integer format: int32 - description: Max depth of the item graph returned. If no depth is set item - graph with max depth is returned. + description: Max depth of the item graph returned. If no depth is set item graph with max depth is returned. maximum: 100 minimum: 1 direction: @@ -2687,17 +2631,16 @@ components: default: downward description: Item graph traversal direction. enum: - - upward - - downward + - upward + - downward key: $ref: '#/components/schemas/PartChainIdentificationKey' lookupBPNs: type: boolean deprecated: true - description: Flag to specify whether BPNs should be collected and resolved - via the configured BPDM URL. Default is false. + description: Flag to specify whether BPNs should be collected and resolved via the configured BPDM URL. Default is false. required: - - key + - key Relationship: type: object additionalProperties: false @@ -2760,8 +2703,7 @@ components: Submodel: type: object additionalProperties: false - description: "Submodel with identification of SubmodelDescriptor, aspect type\ - \ and payload as String" + description: "Submodel with identification of SubmodelDescriptor, aspect type and payload as String" properties: aspectType: type: string @@ -2844,11 +2786,10 @@ components: validUntil: type: string format: date-time - description: Timestamp after which the policy will no longer be accepted - in negotiations. + description: Timestamp after which the policy will no longer be accepted in negotiations. required: - - policyIds - - validUntil + - policyIds + - validUntil securitySchemes: api_key: description: Api Key access diff --git a/irs-api/src/main/java/org/eclipse/tractusx/irs/IrsApplication.java b/irs-api/src/main/java/org/eclipse/tractusx/irs/IrsApplication.java index e37f31b068..8cc3f2d8ba 100644 --- a/irs-api/src/main/java/org/eclipse/tractusx/irs/IrsApplication.java +++ b/irs-api/src/main/java/org/eclipse/tractusx/irs/IrsApplication.java @@ -59,7 +59,7 @@ public class IrsApplication { /** * The IRS API version. */ - public static final String API_VERSION = "5.1.4"; + public static final String API_VERSION = "5.1.5"; /** * The URL prefix for IRS API URLs.