diff --git a/docs/src/api/irs-api.yaml b/docs/src/api/irs-api.yaml index 67f90e2399..0e2af21a7a 100644 --- a/docs/src/api/irs-api.yaml +++ b/docs/src/api/irs-api.yaml @@ -5,9 +5,9 @@ info: title: IRS API version: 4.9.0 servers: - - url: http://localhost:8080 +- url: http://localhost:8080 security: - - api_key: [] +- api_key: [] paths: /ess/bpn/investigations: post: @@ -58,24 +58,24 @@ paths: $ref: '#/components/schemas/ErrorResponse' description: Authorization refused by server. security: - - api_key: [] + - 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,10 +123,10 @@ 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 @@ -152,11 +152,48 @@ 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. + operationId: getAllAspectModels + responses: + "200": + content: + application/json: + examples: + complete: + $ref: '#/components/examples/aspect-models-list' + schema: + $ref: '#/components/schemas/AspectModels' + description: Returns all available aspect models. + "401": + content: + application/json: + examples: + error: + $ref: '#/components/examples/error-response-401' + schema: + $ref: '#/components/schemas/ErrorResponse' + description: No valid authentication credentials. + "403": + content: + application/json: + examples: + error: + $ref: '#/components/examples/error-response-403' + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Authorization refused by server. + security: + - api_key: [] + summary: Get all available aspect models from semantic hub or local models. + tags: + - 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: @@ -202,57 +239,57 @@ 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\ + - 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 + in: query + name: sort + required: false + schema: + type: array + items: + type: string responses: "200": content: @@ -289,10 +326,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 @@ -340,33 +377,34 @@ 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: @@ -424,24 +462,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: @@ -489,51 +527,14 @@ 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 - /irs/aspectmodels: - get: - description: Get all available aspect models from semantic hub or local models. - operationId: getAllAspectModels - responses: - "200": - content: - application/json: - examples: - complete: - $ref: "#/components/examples/aspect-models-list" - schema: - $ref: "#/components/schemas/AspectModels" - description: Returns all available aspect models. - "401": - content: - application/json: - examples: - error: - $ref: "#/components/examples/error-response-401" - schema: - $ref: "#/components/schemas/ErrorResponse" - description: No valid authentication credentials. - "403": - content: - application/json: - examples: - error: - $ref: "#/components/examples/error-response-403" - schema: - $ref: "#/components/schemas/ErrorResponse" - description: Authorization refused by server. - security: - - api_key: [] - summary: Get all available aspect models from semantic hub or local models. - tags: - - Aspect Models + - 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: @@ -579,26 +580,26 @@ 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: @@ -646,24 +647,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: @@ -711,35 +712,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: @@ -787,30 +788,55 @@ 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: - - name: businessPartnerNumbers - description: List of business partner numbers. + - description: List of business partner numbers. in: query + name: businessPartnerNumbers required: false schema: - type: array - items: - type: string + 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': policy-id3 + policy: + policyId: p3 + createdOn: 2024-03-28T03:34:42.9454448Z + validUntil: 2025-12-12T23:59:59.999Z + permissions: + - action: USE + constraint: + and: + - leftOperand: Membership + operator: + '@id': eq + odrl:rightOperand: active + - leftOperand: PURPOSE + operator: + '@id': eq + odrl:rightOperand: ID 3.1 Trace + or: null + BPNA1234567890DF: [] schema: - description: Map of BPN to list of policies type: string + description: Map of BPN to list of policies description: Returns the policies as map of BPN to list of policies. "401": content: @@ -831,10 +857,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 @@ -888,10 +914,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 @@ -941,20 +967,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 @@ -986,12 +1012,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 components: examples: + aspect-models-list: + value: + lastUpdated: 2023-02-13T08:18:11.990659500Z + models: + - name: SingleLevelBomAsBuilt + status: RELEASED + type: BAMM + urn: urn:samm:io.catenax.single_level_bom_as_built:3.0.0#SingleLevelBomAsBuilt + version: 2.0.0 + - name: SerialPart + status: RELEASED + type: BAMM + urn: urn:bamm:io.catenax.serial_part:1.0.1#SerialPart + version: 1.0.1 canceled-job-response: value: completedOn: 2022-02-03T14:48:54.709Z @@ -1041,10 +1081,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 @@ -1052,8 +1092,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 @@ -1085,92 +1125,92 @@ components: completed: 3 failed: 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 + - 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" + - 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:bamm:io.catenax.single_level_bom_as_planned:2.0.0#SingleLevelBomAsPlanned - 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 + - 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:bamm:io.catenax.single_level_bom_as_planned:2.0.0#SingleLevelBomAsPlanned + 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 @@ -1178,8 +1218,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 @@ -1208,18 +1248,18 @@ 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: @@ -1230,107 +1270,107 @@ components: id: urn:uuid:882fc530-b69b-4707-95f6-5dbc5e9baaa8 idShort: future concept x specificAssetIds: - - name: engineserialid - value: "12309481209312" + - 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 - idShort: SingleLevelBomAsPlanned - id: urn:uuid:5d25a897-6571-4800-b98c-a3352fbf996d - semanticId: - type: ModelReference - keys: - - type: ExternalReference - value: urn:bamm:io.catenax.single_level_bom_as_planned:2.0.0#SingleLevelBomAsPlanned - - description: - - language: en - text: Provides base vehicle information - endpoints: - - interface: HTTP - protocolInformation: - href: https://catena-x.net/vehicle/partdetails/ - endpointProtocol: HTTPS - endpointProtocolVersion: - - "1.0" - 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 + - 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:bamm:io.catenax.single_level_bom_as_planned:2.0.0#SingleLevelBomAsPlanned + 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: - - createdOn: 2022-02-03T14:48:54.709Z - catenaXId: urn:uuid:d9bec1c6-e47c-4d18-ba41-0a5fe8b7f447 - 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 + - 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: + - catenaXId: urn:uuid:d9bec1c6-e47c-4d18-ba41-0a5fe8b7f447 + createdOn: 2022-02-03T14:48:54.709Z + 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 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: @@ -1376,8 +1416,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 @@ -1406,18 +1446,18 @@ 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: @@ -1428,71 +1468,73 @@ components: id: urn:uuid:882fc530-b69b-4707-95f6-5dbc5e9baaa8 idShort: future concept x specificAssetIds: - - name: engineserialid - value: "12309481209312" + - 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: - type: ModelReference - keys: - - type: ExternalReference - value: urn:bamm:io.catenax.single_level_bom_as_planned:2.0.0#SingleLevelBomAsPlanned - - description: - - language: en - text: Provides base vehicle information - endpoints: - - interface: HTTP - protocolInformation: - href: https://catena-x.net/vehicle/partdetails/ - endpointProtocol: HTTPS - endpointProtocolVersion: ["1.0"] - 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: - type: ModelReference - keys: - - type: Submodel - value: urn:bamm:io.catenax.vehicle:0.1.1#PartDetails + - 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:bamm:io.catenax.single_level_bom_as_planned:2.0.0#SingleLevelBomAsPlanned + 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: - - createdOn: 2022-02-03T14:48:54.709Z - catenaXId: urn:uuid:d9bec1c6-e47c-4d18-ba41-0a5fe8b7f447 - 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 + - 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: + - catenaXId: urn:uuid:d9bec1c6-e47c-4d18-ba41-0a5fe8b7f447 + createdOn: 2022-02-03T14:48:54.709Z + 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 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: [] @@ -1526,20 +1568,6 @@ components: relationships: [] submodels: [] tombstones: [] - aspect-models-list: - value: - lastUpdated: 2023-02-13T08:18:11.990659500Z - models: - - urn: urn:samm:io.catenax.single_level_bom_as_built:3.0.0#SingleLevelBomAsBuilt - name: SingleLevelBomAsBuilt - status: RELEASED - type: BAMM - version: 2.0.0 - - urn: urn:bamm:io.catenax.serial_part:1.0.1#SerialPart - name: SerialPart - status: RELEASED - type: BAMM - version: 1.0.1 schemas: AdministrativeInformation: type: object @@ -1549,6 +1577,33 @@ components: type: string version: type: string + AspectModel: + type: object + additionalProperties: false + properties: + name: + type: string + status: + type: string + type: + type: string + urn: + type: string + version: + type: string + AspectModels: + type: object + additionalProperties: false + example: |- + {"lastUpdated"="2023-02-13T08:18:11.990659500Z", "models"=[{"name"="SingleLevelBomAsBuilt", "status"="RELEASED", "type"="BAMM", "urn"="urn:bamm:io.catenax.single_level_bom_as_built:1.0.0#SingleLevelBomAsBuilt", "version"="1.0.0"}, + {"name"="SerialPart", "status"="RELEASED", "type"="BAMM", "urn"="urn:bamm:io.catenax.serial_part:1.0.0#SerialPart", "version"="1.0.0"}]} + properties: + lastUpdated: + type: string + models: + type: array + items: + $ref: '#/components/schemas/AspectModel' AssetAdministrationShellDescriptor: type: object additionalProperties: false @@ -1617,6 +1672,11 @@ 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\"}" properties: batchChecksum: type: integer @@ -1639,25 +1699,21 @@ components: type: string description: The state of the order. enum: - - INITIALIZED - - COMPLETED - - PROCESSING - - PARTIAL - - ERROR - 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 + - 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}" properties: batchId: type: string @@ -1674,11 +1730,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 @@ -1710,21 +1766,6 @@ components: type: integer format: int32 description: Total amount of jobs inside the order. - 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 Bpn: type: object additionalProperties: false @@ -1736,30 +1777,6 @@ components: manufacturerName: type: string example: OEM A - Constraint: - type: object - additionalProperties: false - properties: - leftOperand: - type: string - example: string - 'odrl:rightOperand': - type: string - example: string - operator: - $ref: '#/components/schemas/Operator' - Constraints: - type: object - additionalProperties: false - properties: - and: - type: array - items: - $ref: '#/components/schemas/Constraint' - or: - type: array - items: - $ref: '#/components/schemas/Constraint' CreatePoliciesResponse: type: object additionalProperties: false @@ -1781,47 +1798,51 @@ components: example: BPNL1234567890AB pattern: "(BPN)[LSA][\\w\\d]{10}[\\w\\d]{2}" payload: - type: array - items: - $ref: '#/components/schemas/JsonObject' + type: object + additionalProperties: + $ref: '#/components/schemas/JsonValue' + description: The policy payload. example: - payload: - '@context': - odrl: http://www.w3.org/ns/odrl/2/ - '@id': policy-id - 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 - validUntil: '2025-12-12T23:59:59.999Z' + '@context': + odrl: http://www.w3.org/ns/odrl/2/ + '@id': policy-id + '@type': PolicyDefinitionRequestDto + 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 + properties: + empty: + type: boolean + valueType: + type: string + enum: + - 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. - example: '2025-12-12T23:59:59.999Z' - required: - - payload - - validUntil - EdcNotificationResponseNotificationContent: - type: object - additionalProperties: false - properties: - content: - $ref: '#/components/schemas/ResponseNotificationContent' - header: - $ref: '#/components/schemas/EdcNotificationHeader' + description: Timestamp after which the policy will no longer be accepted + in negotiations. + example: 2025-12-12T23:59:59.999Z required: - - content - - header + - payload + - validUntil EdcNotificationHeader: type: object additionalProperties: false @@ -1844,10 +1865,21 @@ components: senderEdc: type: string required: - - notificationId - - notificationType - - recipientBpn - - senderBpn + - notificationId + - notificationType + - recipientBpn + - senderBpn + EdcNotificationResponseNotificationContent: + type: object + additionalProperties: false + properties: + content: + $ref: '#/components/schemas/ResponseNotificationContent' + header: + $ref: '#/components/schemas/EdcNotificationHeader' + required: + - content + - header Endpoint: type: object additionalProperties: false @@ -1875,79 +1907,81 @@ 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 properties: + externalSubjectId: + $ref: '#/components/schemas/Reference' name: type: string example: engineserialid @@ -1955,8 +1989,6 @@ components: $ref: '#/components/schemas/Reference' subjectId: $ref: '#/components/schemas/Reference' - externalSubjectId: - $ref: '#/components/schemas/Reference' value: type: string example: "12309481209312" @@ -1985,8 +2017,8 @@ components: id: type: string format: uuid - example: e5347c88-a921-11ec-b909-0242ac120002 description: Id of the job. + example: e5347c88-a921-11ec-b909-0242ac120002 maxLength: 36 minLength: 36 pattern: "/^[0-9a-f]{8}-[0-9a-f]{4}-[0-5][0-9a-f]{3}-[089ab][0-9a-f]{3}-[0-9a-f]{12}$/i" @@ -2002,21 +2034,21 @@ components: example: 2022-02-03T14:48:54.709Z state: type: string - example: COMPLETED 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 @@ -2024,8 +2056,8 @@ components: properties: errorDetail: type: string - example: Timeout while requesting Digital Registry description: Detailed exception information. + example: Timeout while requesting Digital Registry maxLength: 4000 exception: type: string @@ -2062,19 +2094,19 @@ components: example: false bomLifecycle: type: string - example: asBuilt 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 example: BPNL00000003AYRE callbackUrl: type: string - example: https://hostname.com/callback?id={id}&state={state} + example: "https://hostname.com/callback?id={id}&state={state}" collectAspects: type: boolean example: false @@ -2086,11 +2118,11 @@ components: minimum: 0 direction: type: string - example: upward description: Item graph traversal direction. enum: - - upward - - downward + - upward + - downward + example: upward lookupBPNs: type: boolean example: false @@ -2110,131 +2142,20 @@ 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 description: Container for a job with item graph. - example: - bpns: - - manufacturerId: BPNL00000003AAXX - manufacturerName: AB CD - job: - completedOn: '2022-02-03T14:48:54.709Z' - createdOn: '2022-02-03T14:48:54.709Z' - exception: - errorDetail: Timeout while requesting Digital Registry - exception: IrsTimeoutException - exceptionDate: '2022-02-03T14:48:54.709Z' - globalAssetId: urn:uuid:6c311d29-5753-46d4-b32c-19b918ea93b0 - id: e5347c88-a921-11ec-b909-0242ac120002 - lastModifiedOn: '2022-02-03T14:48:54.709Z' - parameter: - aspects: - - SerialPart - - AddressAspect - auditContractNegotiation: false - bomLifecycle: asBuilt - collectAspects: false - depth: 1 - direction: downward - lookupBPNs: false - startedOn: '2022-02-03T14:48:54.709Z' - state: COMPLETED - summary: - asyncFetchedItems: - completed: 3 - failed: 0 - running: 0 - bpnLookups: - completed: 3 - failed: 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 - 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:bamm:io.catenax.single_level_bom_as_planned:2.0.0#SingleLevelBomAsPlanned - 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:com.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' - 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 + example: |- + {"bpns"=[{"manufacturerId"="BPNL00000003AAXX", "manufacturerName"="AB CD"}], "job"={"completedOn"="2022-02-03T14:48:54.709Z", "createdOn"="2022-02-03T14:48:54.709Z", "exception"={"errorDetail"="Timeout while requesting Digital Registry", "exception"="IrsTimeoutException", "exceptionDate"="2022-02-03T14:48:54.709Z"}, "globalAssetId"="urn:uuid:6c311d29-5753-46d4-b32c-19b918ea93b0", "id"="e5347c88-a921-11ec-b909-0242ac120002", "lastModifiedOn"="2022-02-03T14:48:54.709Z", "parameter"={"aspects"=["SerialPart", "AddressAspect"], "auditContractNegotiation"=false, "bomLifecycle"="asBuilt", "collectAspects"=false, "depth"=1, "direction"="downward", "lookupBPNs"=false}, "startedOn"="2022-02-03T14:48:54.709Z", "state"="COMPLETED", "summary"={"asyncFetchedItems"={"completed"=3, "failed"=0, "running"=0}, "bpnLookups"={"completed"=3, "failed"=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}}}], "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:bamm:io.catenax.single_level_bom_as_planned:2.0.0#SingleLevelBomAsPlanned"}], "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:com.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"}}], "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}}]} properties: bpns: type: array @@ -2270,74 +2191,40 @@ components: items: $ref: '#/components/schemas/Tombstone' maxItems: 2147483647 - JsonObject: - type: object - additionalProperties: false - properties: - valueType: - type: string - enum: - - 'ARRAY' - - 'OBJECT' - - 'STRING' - - 'NUMBER' - - 'TRUE' - - 'FALSE' - - 'NULL' - empty: - type: boolean - example: - payload: - '@context': - odrl: http://www.w3.org/ns/odrl/2/ - '@id': policy-id - 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 - validUntil: '2025-12-12T23:59:59.999Z' JsonValue: type: object additionalProperties: false + description: The policy payload. + example: + '@context': + odrl: http://www.w3.org/ns/odrl/2/ + '@id': policy-id + '@type': PolicyDefinitionRequestDto + 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 properties: valueType: type: string enum: - - 'ARRAY' - - 'OBJECT' - - 'STRING' - - 'NUMBER' - - 'TRUE' - - 'FALSE' - - 'NULL' - example: - payload: - '@context': - odrl: http://www.w3.org/ns/odrl/2/ - '@id': policy-id - 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 - validUntil: '2025-12-12T23:59:59.999Z' + - ARRAY + - OBJECT + - STRING + - NUMBER + - "TRUE" + - "FALSE" + - "NULL" LangString: type: object additionalProperties: false @@ -2380,9 +2267,9 @@ components: 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' @@ -2396,40 +2283,12 @@ components: lexicalValue: type: string example: piece - Operator: - type: object - additionalProperties: false - properties: - '@id': - type: string - example: 'odrl:eq' - enum: - - eq - - neq - - lt - - gt - - in - - lteq - - gteq - - isA - - hasPart - - isPartOf - - isOneOf - - isAllOf - - isNoneOf PageResult: type: object additionalProperties: false - example: - pageCount: 0 - pageNumber: 6 - pageSize: 1 - content: - - completedOn: test - id: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - startedOn: 2000-01-23T04:56:07.000+00:00 - state: UNSAVED - 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 @@ -2459,7 +2318,6 @@ components: example: BPNL0123456789XX maxLength: 16 minLength: 16 - #pattern: "^(BPN)(L|S|A)(\\d{10})([a-zA-Z0-9]{2})$" globalAssetId: type: string description: Id of global asset. @@ -2468,54 +2326,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 - Permission: - type: object - additionalProperties: false - properties: - action: - type: string - example: USE - enum: - - ACCESS - - USE - constraint: - $ref: '#/components/schemas/Constraints' - Policy: - example: - createdOn: '2024-03-08T15:19:41.006Z' - permissions: - - action: USE - constraint: - and: - - leftOperand: string - odrl:rightOperand: string - operator: - "@id": odrl:eq - or: - - leftOperand: string - odrl:rightOperand: string - operator: - "@id": odrl:eq - policyId: f253718e-a270-4367-901b-9d50d9bd8462 - validUntil: '2024-03-08T15:19:41.006Z' - type: object - additionalProperties: false - properties: - createdOn: - type: string - format: date-time - permissions: - type: array - items: - $ref: '#/components/schemas/Permission' - policyId: - type: string - example: f253718e-a270-4367-901b-9d50d9bd8462 - validUntil: - type: string - format: date-time + - bpn + - globalAssetId ProcessingError: type: object additionalProperties: false @@ -2528,14 +2340,14 @@ components: processStep: type: string enum: - - SubmodelRequest - - DigitalTwinRequest - - SchemaValidation - - SchemaRequest - - BpdmRequest - - BpdmValidation - - UsagePolicyValidation - - EssValidation + - SubmodelRequest + - DigitalTwinRequest + - SchemaValidation + - SchemaRequest + - BpdmRequest + - BpdmValidation + - UsagePolicyValidation + - EssValidation retryCounter: type: integer format: int32 @@ -2545,28 +2357,29 @@ components: type: object additionalProperties: false properties: - href: - example: https://edc.data.plane/{path}/submodel - type: string endpointProtocol: - example: HTTPS type: string + example: HTTPS endpointProtocolVersion: type: array - example: ["1.0"] + example: + - "1.0" items: type: string - subprotocol: - type: string - subprotocolBody: - type: string - subprotocolBodyEncoding: + href: type: string + example: "https://edc.data.plane/{path}/submodel" securityAttributes: type: array items: $ref: '#/components/schemas/SecurityAttribute' maxItems: 2147483647 + subprotocol: + type: string + subprotocolBody: + type: string + subprotocolBodyEncoding: + type: string Quantity: type: object additionalProperties: false @@ -2576,21 +2389,21 @@ components: $ref: '#/components/schemas/MeasurementUnit' quantityNumber: type: number - example: 1.0 format: double + example: 1.0 maximum: 2147483647 minimum: 0 Reference: type: object additionalProperties: false properties: - type: - type: string keys: type: array items: $ref: '#/components/schemas/SemanticId' maxItems: 2147483647 + type: + type: string RegisterBatchOrder: type: object additionalProperties: false @@ -2604,9 +2417,9 @@ components: - urn:samm:io.catenax.single_level_bom_as_built:3.0.0#SingleLevelBomAsBuilt items: type: string - pattern: ^(urn:[bs]amm:.*\d\.\d\.\d)?(#)?(\w+)?$ + pattern: "^(urn:[bs]amm:.*\\d\\.\\d\\.\\d)?(#)?(\\w+)?$" maxItems: 2147483647 - pattern: ^(urn:[bs]amm:.*\d\.\d\.\d)?(#)?(\w+)?$ + pattern: "^(urn:[bs]amm:.*\\d\\.\\d\\.\\d)?(#)?(\\w+)?$" batchSize: type: integer format: int32 @@ -2618,17 +2431,17 @@ 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. enum: - - asBuilt - - asPlanned - - asSpecified + - asBuilt + - asPlanned + - asSpecified callbackUrl: type: string description: "Callback url to notify requestor when job processing is finished.\ @@ -2651,8 +2464,8 @@ components: default: downward description: Item graph traversal direction. enum: - - upward - - downward + - upward + - downward jobTimeout: type: integer format: int32 @@ -2678,7 +2491,7 @@ components: maximum: 86400 minimum: 60 required: - - keys + - keys RegisterBpnInvestigationBatchOrder: type: object additionalProperties: false @@ -2696,22 +2509,22 @@ 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. 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." + \ 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 @@ -2740,8 +2553,8 @@ components: maximum: 86400 minimum: 60 required: - - incidentBPNSs - - keys + - incidentBPNSs + - keys RegisterBpnInvestigationJob: type: object additionalProperties: false @@ -2752,9 +2565,9 @@ components: 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 @@ -2762,8 +2575,6 @@ components: \ There are two uri variable placeholders that can be used: jobId and\ \ jobState." example: "https://hostname.com/callback?jobId={jobId}&jobState={jobState}" - key: - $ref: '#/components/schemas/PartChainIdentificationKey' incidentBPNSs: type: array description: Array of BPNS numbers. @@ -2774,9 +2585,11 @@ components: pattern: "(BPN)[LSA][\\w\\d]{10}[\\w\\d]{2}" maxItems: 2147483647 pattern: "(BPN)[LSA][\\w\\d]{10}[\\w\\d]{2}" + key: + $ref: '#/components/schemas/PartChainIdentificationKey' required: - - incidentBPNSs - - key + - incidentBPNSs + - key RegisterJob: type: object additionalProperties: false @@ -2790,21 +2603,22 @@ components: - urn:samm:io.catenax.single_level_bom_as_built:3.0.0#SingleLevelBomAsBuilt items: type: string - pattern: ^(urn:[bs]amm:.*\d\.\d\.\d)?(#)?(\w+)?$ + pattern: "^(urn:[bs]amm:.*\\d\\.\\d\\.\\d)?(#)?(\\w+)?$" maxItems: 2147483647 - pattern: ^(urn:[bs]amm:.*\d\.\d\.\d)?(#)?(\w+)?$ + 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. enum: - - asBuilt - - asPlanned - - asSpecified + - asBuilt + - asPlanned + - asSpecified callbackUrl: type: string description: "Callback url to notify requestor when job processing is finished.\ @@ -2826,8 +2640,8 @@ components: default: downward description: Item graph traversal direction. enum: - - upward - - downward + - upward + - downward key: $ref: '#/components/schemas/PartChainIdentificationKey' lookupBPNs: @@ -2835,7 +2649,7 @@ components: 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 @@ -2860,33 +2674,33 @@ components: type: object additionalProperties: false properties: + bpn: + type: string hops: type: integer format: int32 - bpn: - type: string result: type: string - SemanticId: + SecurityAttribute: type: object additionalProperties: false properties: + key: + type: string type: type: string - example: urn:bamm:com.catenax.vehicle:0.1.1 value: type: string - example: Submodel - SecurityAttribute: + SemanticId: type: object additionalProperties: false properties: type: type: string - key: - type: string + example: urn:bamm:com.catenax.vehicle:0.1.1 value: type: string + example: Submodel Shell: type: object additionalProperties: false @@ -2964,43 +2778,6 @@ components: type: object processingError: $ref: '#/components/schemas/ProcessingError' - AspectModel: - type: object - additionalProperties: false - properties: - name: - type: string - status: - type: string - type: - type: string - urn: - type: string - version: - type: string - AspectModels: - type: object - additionalProperties: false - example: - lastUpdated: 2023-02-13T08:18:11.990659500Z - models: - - urn: urn:bamm:io.catenax.single_level_bom_as_built:1.0.0#SingleLevelBomAsBuilt - name: SingleLevelBomAsBuilt - type: BAMM - version: 1.0.0 - status: RELEASED - - urn: urn:bamm:io.catenax.serial_part:1.0.0#SerialPart - name: SerialPart - type: BAMM - version: 1.0.0 - status: RELEASED - properties: - lastUpdated: - type: string - models: - type: array - items: - $ref: '#/components/schemas/AspectModel' UpdatePolicyRequest: type: object additionalProperties: false @@ -3024,8 +2801,8 @@ components: 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