+
+
+
+ A Part as Planned represents an item in the Catena-X Bill of Material(BOM) in As-Planned lifecycle status in a specific version.
+
+
+
+
+
+ Overview
+
+
+
+
+
+
+
+ 
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/io.catenax.part_as_planned/2.0.0/gen/PartAsPlanned.json b/io.catenax.part_as_planned/2.0.0/gen/PartAsPlanned.json
new file mode 100644
index 000000000..fab03069b
--- /dev/null
+++ b/io.catenax.part_as_planned/2.0.0/gen/PartAsPlanned.json
@@ -0,0 +1,14 @@
+{
+ "partTypeInformation" : {
+ "classification" : "product",
+ "manufacturerPartId" : "123-0.740-3434-A",
+ "nameAtManufacturer" : "Mirror left"
+ },
+ "partSitesInformationAsPlanned" : [ {
+ "functionValidUntil" : "2023-12-11T06:14:55.183Z",
+ "catenaXsiteId" : "BPNS1234567890ZZ",
+ "function" : "production",
+ "functionValidFrom" : "2023-12-11T06:14:55.181Z"
+ } ],
+ "catenaXId" : "580d3adf-1981-44a0-a214-13d6ceed9379"
+}
\ No newline at end of file
diff --git a/io.catenax.part_as_planned/2.0.0/gen/PartAsPlanned.yml b/io.catenax.part_as_planned/2.0.0/gen/PartAsPlanned.yml
new file mode 100644
index 000000000..74d5097b6
--- /dev/null
+++ b/io.catenax.part_as_planned/2.0.0/gen/PartAsPlanned.yml
@@ -0,0 +1,252 @@
+---
+openapi: 3.0.3
+info:
+ title: Part as Planned
+ version: v2
+servers:
+- url: catenax.io/api/v2
+ variables:
+ api-version:
+ default: v2
+paths:
+ /{tenant-id}/part-as-planned:
+ get:
+ tags:
+ - PartAsPlanned
+ operationId: getPartAsPlanned
+ parameters:
+ - name: tenant-id
+ in: path
+ description: The ID of the tenant owning the requested Twin.
+ required: true
+ schema:
+ type: string
+ format: uuid
+ - name: start
+ in: query
+ description: Starting index which is starting by 0
+ required: false
+ schema:
+ type: number
+ - name: count
+ in: query
+ description: Number of items to return per call.
+ required: false
+ schema:
+ type: number
+ - name: totalItemCount
+ in: query
+ description: Flag that indicates that the total counts should be returned.
+ required: false
+ schema:
+ type: boolean
+ responses:
+ "200":
+ $ref: '#/components/responses/PartAsPlanned'
+ "401":
+ $ref: '#/components/responses/ClientError'
+ "402":
+ $ref: '#/components/responses/Unauthorized'
+ "403":
+ $ref: '#/components/responses/Forbidden'
+ "404":
+ $ref: '#/components/responses/NotFoundError'
+components:
+ schemas:
+ ErrorResponse:
+ type: object
+ required:
+ - error
+ properties:
+ error:
+ $ref: '#/components/schemas/Error'
+ Error:
+ type: object
+ required:
+ - details
+ properties:
+ message:
+ type: string
+ minLength: 1
+ path:
+ type: string
+ minLength: 1
+ details:
+ type: object
+ minLength: 1
+ additionalProperties:
+ type: object
+ code:
+ type: string
+ nullable: true
+ PagingSchema:
+ type: object
+ properties:
+ items:
+ type: array
+ items:
+ $ref: '#/components/schemas/PartAsPlanned'
+ totalItems:
+ type: number
+ totalPages:
+ type: number
+ pageSize:
+ type: number
+ currentPage:
+ type: number
+ urn_samm_io.catenax.shared.uuid_1.0.0_UuidV4Trait:
+ type: string
+ description: "The provided regular expression ensures that the UUID is composed\
+ \ of five groups of characters separated by hyphens, in the form 8-4-4-4-12\
+ \ for a total of 36 characters (32 hexadecimal characters and 4 hyphens),\
+ \ optionally prefixed by \"urn:uuid:\" to make it an IRI."
+ pattern: "(^[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}$)|(^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}$)"
+ urn_samm_io.catenax.part_as_planned_2.0.0_PartIdCharacteristic:
+ type: string
+ description: "The part ID is a multi-character string, usually assigned by an\
+ \ ERP system"
+ urn_samm_io.catenax.part_as_planned_2.0.0_PartNameCharacteristic:
+ type: string
+ description: Part Name in string format from the respective system in the value
+ chain
+ urn_samm_io.catenax.part_as_planned_2.0.0_ClassificationEnumerationCharacteristic:
+ type: string
+ description: "A part type must be placed into one of the following classes:\
+ \ 'component', 'product', 'software', ?assembly?, 'tool', or 'raw material'."
+ enum:
+ - product
+ - raw material
+ - software
+ - assembly
+ - tool
+ - component
+ urn_samm_io.catenax.part_as_planned_2.0.0_PartTypeInformationCharacteristic:
+ description: The characteristics of the part type
+ type: object
+ properties:
+ manufacturerPartId:
+ description: |-
+ Part ID as assigned by the manufacturer of the part. The Part ID identifies the part in the manufacturer`s dataspace. The Part ID references a specific version of a part. The version number must be included in the Part ID if it is available.
+
+ The Part ID does not reference a specific instance of a part and must not be confused with the serial number.
+ $ref: '#/components/schemas/urn_samm_io.catenax.part_as_planned_2.0.0_PartIdCharacteristic'
+ nameAtManufacturer:
+ description: Name of the part as assigned by the manufacturer
+ $ref: '#/components/schemas/urn_samm_io.catenax.part_as_planned_2.0.0_PartNameCharacteristic'
+ classification:
+ description: The classification of the part type according to STEP standard
+ definition
+ $ref: '#/components/schemas/urn_samm_io.catenax.part_as_planned_2.0.0_ClassificationEnumerationCharacteristic'
+ required:
+ - manufacturerPartId
+ - nameAtManufacturer
+ - classification
+ urn_samm_io.catenax.shared.business_partner_number_1.0.0_BpnsCharacteristic:
+ type: string
+ description: "BPNS (Business Partner Number Site) represents a site which can\
+ \ be a production plant. A site can also be e.g. an office or a warehouse.\
+ \ An information related to a site is e.g. needed for reporting issues (How\
+ \ many sites does e.g. Beispiel AG have?), status of operation (out of operations\
+ \ due to environmental disaster), for certificates on site level (e.g. environment\
+ \ certificates) or for internal regulations on site level, (e.g. security\
+ \ topics, Corona rules,...). Several addresses (= BPNA with different streets\
+ \ and different gates) can belong to one site. A BPNS should be always linked\
+ \ to one BPNL via relationship 'belongs to legal entity'."
+ urn_samm_io.catenax.part_as_planned_2.0.0_FunctionCharacteristic:
+ type: string
+ description: Describes the characteristics of the function for a site related
+ to the respective part
+ enum:
+ - production
+ - warehouse
+ - spare part warehouse
+ urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Timestamp:
+ type: string
+ pattern: "-?([1-9][0-9]{3,}|0[0-9]{3})-(0[1-9]|1[0-2])-(0[1-9]|[12][0-9]|3[01])T(([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9](\\\
+ .[0-9]+)?|(24:00:00(\\.0+)?))(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00))?"
+ description: Describes a Property which contains the date and time with an optional
+ timezone.
+ urn_samm_io.catenax.part_as_planned_2.0.0_partSitesInformationAsPlannedEntity:
+ description: "Describes the ID, function and validity date of a site for the\
+ \ associated part in the AsPlanned context."
+ type: object
+ properties:
+ catenaXsiteId:
+ description: "The identifier of the site according to Catena-X BPDM. The\
+ \ catenaXsiteId must be a valid Catena-X BPN. The BPN is a unique, unchangeable\
+ \ identifier for Business Partners / company locations from foundation\
+ \ to closure, regardless of the different business relationships / structures\
+ \ between or within the Business Partners or company locations."
+ $ref: '#/components/schemas/urn_samm_io.catenax.shared.business_partner_number_1.0.0_BpnsCharacteristic'
+ function:
+ description: The function of the site in relation to the part(i.e. the activity
+ within the value chain of the part that is performed at the site)
+ $ref: '#/components/schemas/urn_samm_io.catenax.part_as_planned_2.0.0_FunctionCharacteristic'
+ functionValidFrom:
+ description: "Timestamp, from when the site has the specified function for\
+ \ the given part"
+ $ref: '#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Timestamp'
+ functionValidUntil:
+ description: "Timestamp, until when the site has the specified function\
+ \ for the given part"
+ $ref: '#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Timestamp'
+ required:
+ - catenaXsiteId
+ - function
+ urn_samm_io.catenax.part_as_planned_2.0.0_partSitesInformationAsPlannedCharacteristic:
+ description: 'The characteristic of the part site information that represents
+ a set of possible site to a repective part. '
+ type: array
+ items:
+ $ref: '#/components/schemas/urn_samm_io.catenax.part_as_planned_2.0.0_partSitesInformationAsPlannedEntity'
+ uniqueItems: true
+ PartAsPlanned:
+ description: 'A Part as Planned represents an item in the Catena-X Bill of Material(BOM)
+ in As-Planned lifecycle status in a specific version. '
+ type: object
+ properties:
+ catenaXId:
+ description: "The fully anonymous Catena-X ID of the serialized part, valid\
+ \ for the Catena-X dataspace."
+ $ref: '#/components/schemas/urn_samm_io.catenax.shared.uuid_1.0.0_UuidV4Trait'
+ partTypeInformation:
+ description: The part type from which the serialized part has been instantiated
+ $ref: '#/components/schemas/urn_samm_io.catenax.part_as_planned_2.0.0_PartTypeInformationCharacteristic'
+ partSitesInformationAsPlanned:
+ description: "A site is a delimited geographical area where a legal entity\
+ \ does business(geographical address with geo coordinates).A site always\
+ \ has a primary physical address. It is possible that further physical\
+ \ addresses are specified for the site. P.O. box details are only possible\
+ \ in addition to the physical address. A site has a 1:n relation to addresses,\
+ \ means at least 1 address is necessary and multiple addresses are possible."
+ $ref: '#/components/schemas/urn_samm_io.catenax.part_as_planned_2.0.0_partSitesInformationAsPlannedCharacteristic'
+ required:
+ - catenaXId
+ - partTypeInformation
+ responses:
+ Unauthorized:
+ description: The requesting user or client is not authenticated.
+ Forbidden:
+ description: The requesting user or client is not authorized to access resources
+ for the given tenant.
+ NotFoundError:
+ description: The requested Twin has not been found.
+ ClientError:
+ description: Payload or user input is invalid. See error details in the payload
+ for more.
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ PartAsPlanned:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/PagingSchema'
+ description: The request was successful.
+ requestBodies:
+ PartAsPlanned:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/PartAsPlanned'
+
+
+Properties
+
+
+
+
+
+
+
+
+
+The fully anonymous Catena-X ID of the serialized part, valid for the Catena-X dataspace.
+
+ Catena-X ID
+
+
+
+
+
+ Name
+ catenaXId
+
+
+
+ Characteristic
+
+
+
+
+
+
+ Trait
+
+
+
+ Reference
+
+
+
+ -
+
- https://tools.ietf.org/html/rfc4122 +
+
+
+ Type http://www.w3.org/2001/XMLSchema#string
+
+
+
+
+
+ Example
+ 580d3adf-1981-44a0-a214-13d6ceed9379
+
+
+
+ Optional
+
+ No
+
+
+
+ In payload
+
+ Yes
+
+
+
+
+ Payload key
+ catenaXId
+
+
+Constraints
+
+
+-
+
-
++ +++ UUID v4 Regular Expression ++ +++ +Description+The provided regular expression ensures that the UUID is composed of five groups of characters separated by hyphens, in the form 8-4-4-4-12 for a total of 36 characters (32 hexadecimal characters and 4 hyphens), optionally prefixed by "urn:uuid:" to make it an IRI.+++ +Reference+++++
-
+
- https://datatracker.ietf.org/doc/html/rfc4122 +
++ + + +Regular expression+(^[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}$)|(^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}$)+
+
+
+
+
+
+A site is a delimited geographical area where a legal entity does business(geographical address with geo coordinates).A site always has a primary physical address. It is possible that further physical addresses are specified for the site. P.O. box details are only possible in addition to the physical address. A site has a 1:n relation to addresses, means at least 1 address is necessary and multiple addresses are possible.
+
+ Part Sites Information as Planned
+
+
+
+
+
+ Name
+ partSitesInformationAsPlanned
+
+
+
+
+ Characteristic
+
+
+
+
+
+
+ Set
+
+
+ Has no order
+
+
+
+ Duplicates not allowed
+
+
+
+ Optional
+
+ Yes
+
+
+
+ In payload
+
+ Yes
+
+
+
+ Payload key
+ partSitesInformationAsPlanned
+
+
+
+Reference
+
+
+ -
+
- https://confluence.catena-x.net/x/QkBHAw +
+
+
+
+
+
+The part type from which the serialized part has been instantiated
+
+ Part Type Information
+
+
+
+
+
+ Name
+ partTypeInformation
+
+
+
+
+ Characteristic
+
+
+
+
+
+
+
+ SingleEntity
+
+
+
+ Optional
+
+ No
+
+
+
+ In payload
+
+ Yes
+
+
+
+
+Payload key
+ partTypeInformation
+
+
+
+
+
+
+ Entities
+
+
+
+
+ Part Sites Information as Planned Entity
+
+ Describes the ID, function and validity date of a site for the associated part in the AsPlanned context.
+
+
+
+
+Properties
+
+
+
+
+
+
+The identifier of the site according to Catena-X BPDM. The catenaXsiteId must be a valid Catena-X BPN. The BPN is a unique, unchangeable identifier for Business Partners / company locations from foundation to closure, regardless of the different business relationships / structures between or within the Business Partners or company locations.
+
+ Catena-X site identifier
+
+
+
+
+
+ Name
+ catenaXsiteId
+
+
+
+ Characteristic
+
+
+
+
+
+
+
+ Reference
+
+
+
+ -
+
- https://catena-x.net/fileadmin/user_upload/Standard-Bibliothek/Update_PDF_Maerz/5_BPDM/CX_-_0010_BUSINESS_PARTNER_NUMBER_PlatformCapabilityBPDM_v_1.0.1.pdf +
+
+
+ Type http://www.w3.org/2001/XMLSchema#string
+
+
+
+
+
+ Example
+ BPNS1234567890ZZ
+
+
+
+ Optional
+
+ No
+
+
+
+ In payload
+
+ Yes
+
+
+
+
+Payload key
+ catenaXsiteId
+
+
+
+
+
+
+The function of the site in relation to the part(i.e. the activity within the value chain of the part that is performed at the site)
+
+ Function
+
+
+
+
+
+ Name
+ function
+
+
+
+ Characteristic
+
+
+
+
+
+
+ Enumeration
+
+
+ Values
+
+
+
+
+ -
+
- production +
- warehouse +
- spare part warehouse +
+
+
+ Type http://www.w3.org/2001/XMLSchema#string
+
+
+
+
+
+ Example
+ production
+
+
+
+ Optional
+
+ No
+
+
+
+ In payload
+
+ Yes
+
+
+
+
+Payload key
+ function
+
+
+
+
+
+
+Timestamp, from when the site has the specified function for the given part
+
+ Function valid from
+
+
+
+
+
+ Name
+ functionValidFrom
+
+
+
+
+ Characteristic
+
+
+
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#dateTime
+
+
+
+
+
+ Optional
+
+ Yes
+
+
+
+ In payload
+
+ Yes
+
+
+
+
+Payload key
+ functionValidFrom
+
+
+
+
+
+
+Timestamp, until when the site has the specified function for the given part
+
+ Function valid until
+
+
+
+
+
+ Name
+ functionValidUntil
+
+
+
+
+ Characteristic
+
+
+
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#dateTime
+
+
+
+
+
+ Optional
+
+ Yes
+
+
+
+ In payload
+
+ Yes
+
+
+
+
+Payload key
+ functionValidUntil
+
+
+
+
+ Part Type Information Entity
+
+ Encapsulation for data related to the part type
+
+
+
+
+Properties
+
+
+
+
+
+
+Part ID as assigned by the manufacturer of the part. The Part ID identifies the part in the manufacturer`s dataspace. The Part ID references a specific version of a part. The version number must be included in the Part ID if it is available.
+
+The Part ID does not reference a specific instance of a part and must not be confused with the serial number.
+
+ Manufacturer Part ID
+
+
+
+
+
+ Name
+ manufacturerPartId
+
+
+
+ Characteristic
+
+
+
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string
+
+
+
+
+
+ Example
+ 123-0.740-3434-A
+
+
+
+ Optional
+
+ No
+
+
+
+ In payload
+
+ Yes
+
+
+
+
+Payload key
+ manufacturerPartId
+
+
+
+
+
+
+Name of the part as assigned by the manufacturer
+
+ Name at manufacturer
+
+
+
+
+
+ Name
+ nameAtManufacturer
+
+
+
+ Characteristic
+
+
+
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string
+
+
+
+
+
+ Example
+ Mirror left
+
+
+
+ Optional
+
+ No
+
+
+
+ In payload
+
+ Yes
+
+
+
+
+Payload key
+ nameAtManufacturer
+
+
+
+
+
+
+The classification of the part type according to STEP standard definition
+
+ Classification
+
+
+
+
+
+ Name
+ classification
+
+
+
+ Characteristic
+
+
+
+
+
+
+ Enumeration
+
+
+ Values
+
+
+
+
+ -
+
- product +
- raw material +
- software +
- assembly +
- tool +
- component +
+
+
+ Reference
+
+
+
+ -
+
- http://private.pdm-if.org/web/pdm-if/recommended-practices1 +
+
+
+ Type http://www.w3.org/2001/XMLSchema#string
+
+
+
+
+
+ Example
+ software
+
+
+
+ Optional
+
+ No
+
+
+
+ In payload
+
+ Yes
+
+
+
+
+Payload key
+ classification
+
+ Third party licenses
+
+
+
+