+
+
+
+ A serialized part is an instantiation of a (design-)part, where the particular instantiation can be uniquely identified by means of a serial number or a similar identifier (e.g. VAN)or a combination of multiple identifiers (e.g. combination of manufacturer, date and number)
+
+
+
+
+
+ Overview
+
+
+
+
+
+
+
+ 
+
+
+
+
+
+
+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
+ urn:uuid: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 local identifier enables identification of a part in a specific dataspace, but is not unique in Catena-X dataspace. Multiple local identifiers may exist.
+
+ Local Identifiers
+
+
+
+
+
+ Name
+ localIdentifiers
+
+
+
+
+ Characteristic
+
+
+
+
+
+
+ Set
+
+
+ Has no order
+
+
+ Duplicates not allowed
+
+
+
+
+
+
+ Optional
+
+ No
+
+
+
+ In payload
+
+ Yes
+
+
+
+
+Payload key
+ localIdentifiers
+
+
+
+
+
+
+Information from manufacturing process, such as manufacturing date and manufacturing country
+
+ Manufacturing Information
+
+
+
+
+
+ Name
+ manufacturingInformation
+
+
+
+
+ Characteristic
+
+
+
+
+
+
+ SingleEntity
+
+
+
+
+
+
+ Optional
+
+ No
+
+
+
+ In payload
+
+ Yes
+
+
+
+
+Payload key
+ manufacturingInformation
+
+
+
+
+
+
+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
+
+
+
+
+ ClassificationEntity
+
+ Encapsulates data related to the classification of the part.
+
+
+
+
+Properties
+
+
+
+
+
+
+Identified classification standards that align to the Catena-X needs.
+
+ Classification Standard
+
+
+
+
+
+ Name
+ classificationStandard
+
+
+
+ Characteristic
+
+
+
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string
+
+
+
+
+
+ Example
+ IEC
+
+
+
+ Optional
+
+ No
+
+
+
+ In payload
+
+ Yes
+
+
+
+
+Payload key
+ classificationStandard
+
+
+
+
+
+
+The classification ID of the part type according to the corresponding standard definition mentioned in the key value pair.
+
+ Classification ID
+
+
+
+
+
+ Name
+ classificationID
+
+
+
+ Characteristic
+
+
+
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string
+
+
+
+
+
+ Example
+ 61360- 2:2012
+
+
+
+ Optional
+
+ No
+
+
+
+ In payload
+
+ Yes
+
+
+
+
+Payload key
+ classificationID
+
+
+
+
+
+
+Optional property describing the classification standard.
+
+ Classification Description
+
+
+
+
+
+ Name
+ classificationDescription
+
+
+
+ Characteristic
+
+
+
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string
+
+
+
+
+
+ Example
+ Standard data element types with associated classification scheme for electric components.
+
+
+
+ Optional
+
+ Yes
+
+
+
+ In payload
+
+ Yes
+
+
+
+
+Payload key
+ classificationDescription
+
+
+
+ Key Value List
+
+ A list of key value pairs for local identifiers, which are composed of a key and a corresponding value.
+
+
+
+
+Properties
+
+
+
+
+
+
+The key of a local identifier.
+
+ Identifier Key
+
+
+
+
+
+ Name
+ key
+
+
+
+ Characteristic
+
+
+
+
+
+
+ Example
+ partInstanceId
+
+
+
+ Optional
+
+ No
+
+
+
+ In payload
+
+ Yes
+
+
+
+
+ Payload key
+ key
+
+
+Constraints
+
+
+-
+
-
++ +++ Key Regular Expression ++ +++ + +Description+Constraint that ensures that the standard keys and custom key prefixes can be used.+++ + + +Regular expression+^(manufacturerId|partInstanceId|batchId|van|customKey:\w+)$+
+
+
+
+
+
+The value of an identifier.
+
+ Identifier Value
+
+
+
+
+
+ Name
+ value
+
+
+
+ Characteristic
+
+
+
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string
+
+
+
+
+
+ Example
+ SN12345678
+
+
+
+ Optional
+
+ No
+
+
+
+ In payload
+
+ Yes
+
+
+
+
+Payload key
+ value
+
+
+
+ Manufacturing Entity
+
+ Encapsulates the manufacturing relevant attributes
+
+
+
+
+Properties
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/io.catenax.serial_part/3.0.0/gen/SerialPart.json b/io.catenax.serial_part/3.0.0/gen/SerialPart.json
new file mode 100644
index 000000000..c573ef0c3
--- /dev/null
+++ b/io.catenax.serial_part/3.0.0/gen/SerialPart.json
@@ -0,0 +1,26 @@
+{
+ "localIdentifiers" : [ {
+ "value" : "SN12345678",
+ "key" : "partInstanceId"
+ } ],
+ "manufacturingInformation" : {
+ "date" : "2022-02-04T14:48:54",
+ "country" : "HUR",
+ "sites" : [ {
+ "catenaXsiteId" : "BPNS1234567890ZZ",
+ "function" : "production"
+ } ]
+ },
+ "catenaXId" : "urn:uuid:580d3adf-1981-44a0-a214-13d6ceed9379",
+ "partTypeInformation" : {
+ "partClassification" : [ {
+ "classificationStandard" : "IEC",
+ "classificationID" : "61360- 2:2012 ",
+ "classificationDescription" : "Standard data element types with associated classification scheme for electric components."
+ } ],
+ "manufacturerPartId" : "123-0.740-3434-A",
+ "customerPartId" : "PRT-12345",
+ "nameAtManufacturer" : "Mirror left",
+ "nameAtCustomer" : "side element A"
+ }
+}
\ No newline at end of file
diff --git a/io.catenax.serial_part/3.0.0/gen/SerialPart.yml b/io.catenax.serial_part/3.0.0/gen/SerialPart.yml
new file mode 100644
index 000000000..61d8d09b9
--- /dev/null
+++ b/io.catenax.serial_part/3.0.0/gen/SerialPart.yml
@@ -0,0 +1,328 @@
+---
+openapi: 3.0.3
+info:
+ title: Serial Part
+ version: v3
+servers:
+- url: catenax.io/api/v3
+ variables:
+ api-version:
+ default: v3
+paths:
+ /{tenant-id}/serial-part:
+ get:
+ tags:
+ - SerialPart
+ operationId: getSerialPart
+ 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/SerialPart'
+ "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/SerialPart'
+ totalItems:
+ type: number
+ totalPages:
+ type: number
+ pageSize:
+ type: number
+ currentPage:
+ type: number
+ urn_samm_io.catenax.shared.uuid_2.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.serial_part_3.0.0_KeyTrait:
+ type: string
+ description: Constraint that ensures that the standard keys and custom key prefixes
+ can be used.
+ pattern: ^(manufacturerId|partInstanceId|batchId|van|customKey:\w+)$
+ urn_samm_io.catenax.serial_part_3.0.0_ValueCharacteristic:
+ type: string
+ description: The value of an identifier.
+ urn_samm_io.catenax.serial_part_3.0.0_KeyValueList:
+ description: "A list of key value pairs for local identifiers, which are composed\
+ \ of a key and a corresponding value."
+ type: object
+ properties:
+ key:
+ description: 'The key of a local identifier. '
+ $ref: '#/components/schemas/urn_samm_io.catenax.serial_part_3.0.0_KeyTrait'
+ value:
+ description: The value of an identifier.
+ $ref: '#/components/schemas/urn_samm_io.catenax.serial_part_3.0.0_ValueCharacteristic'
+ required:
+ - key
+ - value
+ urn_samm_io.catenax.serial_part_3.0.0_LocalIdentifierCharacteristic:
+ description: "A single serialized part may have multiple attributes, that uniquely\
+ \ identify a that part in a specific dataspace (e.g. the manufacturer`s dataspace)"
+ type: array
+ items:
+ $ref: '#/components/schemas/urn_samm_io.catenax.serial_part_3.0.0_KeyValueList'
+ uniqueItems: true
+ urn_samm_io.catenax.serial_part_3.0.0_DateTimeTrait:
+ type: string
+ description: Regular Expression to enable UTC and Timezone formats and the possibility
+ to exclude time information.
+ pattern: "^(?:[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}(?:[.][0-9]+)?Z|[0-9]{4}-[0-9]{2}-[0-9]{2}(?:T[0-9]{2}:[0-9]{2}:[0-9]{2}(?:[.][0-9]+)?(?:Z|[+-][0-9]{2}:[0-9]{2}))?)$"
+ urn_samm_io.catenax.serial_part_3.0.0_ProductionCountryCodeTrait:
+ type: string
+ description: 'Regular Expression that ensures a three-letter code '
+ pattern: "^[A-Z][A-Z][A-Z]$"
+ urn_samm_io.catenax.shared.business_partner_number_2.0.0_BpnsTrait:
+ type: string
+ description: "The provided regular expression ensures that the BPNS is composed\
+ \ of prefix 'BPNS', 10 digits and two alphanumeric letters."
+ pattern: "^BPNS[a-zA-Z0-9]{12}$"
+ urn_samm_io.catenax.shared.part_site_information_as_built_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_io.catenax.shared.part_site_information_as_built_2.0.0_SitesEntity:
+ description: "Describes the ID and function of a site for the associated part\
+ \ in the AsBuilt context(e.g. SerialPart, Batch, jIS)."
+ 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_2.0.0_BpnsTrait'
+ 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.shared.part_site_information_as_built_2.0.0_FunctionCharacteristic'
+ required:
+ - catenaXsiteId
+ - function
+ urn_samm_io.catenax.shared.part_site_information_as_built_2.0.0_SitesCharacteristic:
+ description: Sites Characteristic
+ type: array
+ items:
+ $ref: '#/components/schemas/urn_samm_io.catenax.shared.part_site_information_as_built_2.0.0_SitesEntity'
+ uniqueItems: true
+ urn_samm_io.catenax.serial_part_3.0.0_ManufacturingCharacteristic:
+ description: Characteristic to describe manufacturing related data
+ type: object
+ properties:
+ date:
+ description: "Timestamp of the manufacturing date as the final step in production\
+ \ process (e.g. final quality check, ready-for-shipment event)"
+ $ref: '#/components/schemas/urn_samm_io.catenax.serial_part_3.0.0_DateTimeTrait'
+ country:
+ description: Country code where the part was manufactured
+ $ref: '#/components/schemas/urn_samm_io.catenax.serial_part_3.0.0_ProductionCountryCodeTrait'
+ sites:
+ 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.shared.part_site_information_as_built_2.0.0_SitesCharacteristic'
+ required:
+ - date
+ urn_samm_io.catenax.serial_part_3.0.0_PartIdCharacteristic:
+ type: string
+ description: "The part ID is a multi-character string, usually assigned by an\
+ \ ERP system"
+ urn_samm_io.catenax.serial_part_3.0.0_PartNameCharacteristic:
+ type: string
+ description: Part Name in string format from the respective system in the value
+ chain
+ urn_samm_io.catenax.shared.part_classification_1.0.0_ClassificationStandardCharacteristic:
+ type: string
+ description: Identified classification standards that align to the Catena-X
+ needs.
+ urn_samm_io.catenax.shared.part_classification_1.0.0_ClassificationIDCharacteristic:
+ type: string
+ description: "It can be numeric or a string, depending on the chosen classification\
+ \ standard."
+ urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text:
+ type: string
+ description: "Describes a Property which contains plain text. This is intended\
+ \ exclusively for human readable strings, not for identifiers, measurement\
+ \ values, etc."
+ urn_samm_io.catenax.shared.part_classification_1.0.0_ClassificationEntity:
+ description: Encapsulates data related to the classification of the part.
+ type: object
+ properties:
+ classificationStandard:
+ description: Identified classification standards that align to the Catena-X
+ needs.
+ $ref: '#/components/schemas/urn_samm_io.catenax.shared.part_classification_1.0.0_ClassificationStandardCharacteristic'
+ classificationID:
+ description: The classification ID of the part type according to the corresponding
+ standard definition mentioned in the key value pair.
+ $ref: '#/components/schemas/urn_samm_io.catenax.shared.part_classification_1.0.0_ClassificationIDCharacteristic'
+ classificationDescription:
+ description: Optional property describing the classification standard.
+ $ref: '#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text'
+ required:
+ - classificationStandard
+ - classificationID
+ urn_samm_io.catenax.shared.part_classification_1.0.0_ClassificationCharacteristic:
+ description: Classification characteristic enabling a set of further properties.
+ type: array
+ items:
+ $ref: '#/components/schemas/urn_samm_io.catenax.shared.part_classification_1.0.0_ClassificationEntity'
+ uniqueItems: true
+ urn_samm_io.catenax.serial_part_3.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 (as designed)in the manufacturer`s dataspace. The
+ Part ID does not reference a specific instance of a part and thus should
+ not be confused with the serial number.
+ $ref: '#/components/schemas/urn_samm_io.catenax.serial_part_3.0.0_PartIdCharacteristic'
+ customerPartId:
+ description: Part ID as assigned by the manufacturer of the part. The Part
+ ID identifies the part (as designed)in the customer`s dataspace. The Part
+ ID does not reference a specific instance of a part and thus should not
+ be confused with the serial number.
+ $ref: '#/components/schemas/urn_samm_io.catenax.serial_part_3.0.0_PartIdCharacteristic'
+ nameAtManufacturer:
+ description: Name of the part as assigned by the manufacturer
+ $ref: '#/components/schemas/urn_samm_io.catenax.serial_part_3.0.0_PartNameCharacteristic'
+ nameAtCustomer:
+ description: Name of the part as assigned by the customer
+ $ref: '#/components/schemas/urn_samm_io.catenax.serial_part_3.0.0_PartNameCharacteristic'
+ partClassification:
+ description: Property describing the classification of a part.
+ $ref: '#/components/schemas/urn_samm_io.catenax.shared.part_classification_1.0.0_ClassificationCharacteristic'
+ required:
+ - manufacturerPartId
+ - nameAtManufacturer
+ SerialPart:
+ description: "A serialized part is an instantiation of a (design-)part, where\
+ \ the particular instantiation can be uniquely identified by means of a serial\
+ \ number or a similar identifier (e.g. VAN)or a combination of multiple identifiers\
+ \ (e.g. combination of manufacturer, date and number)"
+ 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_2.0.0_UuidV4Trait'
+ localIdentifiers:
+ description: "A local identifier enables identification of a part in a specific\
+ \ dataspace, but is not unique in Catena-X dataspace. Multiple local identifiers\
+ \ may exist."
+ $ref: '#/components/schemas/urn_samm_io.catenax.serial_part_3.0.0_LocalIdentifierCharacteristic'
+ manufacturingInformation:
+ description: "Information from manufacturing process, such as manufacturing\
+ \ date and manufacturing country"
+ $ref: '#/components/schemas/urn_samm_io.catenax.serial_part_3.0.0_ManufacturingCharacteristic'
+ partTypeInformation:
+ description: The part type from which the serialized part has been instantiated
+ $ref: '#/components/schemas/urn_samm_io.catenax.serial_part_3.0.0_PartTypeInformationCharacteristic'
+ required:
+ - catenaXId
+ - localIdentifiers
+ - manufacturingInformation
+ - 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'
+ SerialPart:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/PagingSchema'
+ description: The request was successful.
+ requestBodies:
+ SerialPart:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/SerialPart'
+
+
+Timestamp of the manufacturing date as the final step in production process (e.g. final quality check, ready-for-shipment event)
+
+ Production Date
+
+
+
+
+
+ Name
+ date
+
+
+
+ Characteristic
+
+
+
+
+
+
+ Example
+ 2022-02-04T14:48:54
+
+
+
+ Optional
+
+ No
+
+
+
+ In payload
+
+ Yes
+
+
+
+
+ Payload key
+ date
+
+
+Constraints
+
+
+-
+
-
++ +++ Date Time Regular Expression ++ +++ + +Description+Regular Expression to enable UTC and Timezone formats and the possibility to exclude time information.+++ + + +Regular expression+^(?:[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}(?:[.][0-9]+)?Z|[0-9]{4}-[0-9]{2}-[0-9]{2}(?:T[0-9]{2}:[0-9]{2}:[0-9]{2}(?:[.][0-9]+)?(?:Z|[+-][0-9]{2}:[0-9]{2}))?)$+
+
+
+
+
+
+Country code where the part was manufactured
+
+ Country code
+
+
+
+
+
+ Name
+ country
+
+
+
+ Characteristic
+
+
+
+
+
+
+ Trait
+
+
+
+ Reference
+
+
+
+ -
+
- https://www.iso.org/iso-3166-country-codes.html +
+
+
+ Type http://www.w3.org/2001/XMLSchema#string
+
+
+
+
+
+ Example
+ HUR
+
+
+
+ Optional
+
+ Yes
+
+
+
+ In payload
+
+ Yes
+
+
+
+
+ Payload key
+ country
+
+
+Constraints
+
+
+-
+
-
++ +++ Country Code Regular Expression ++ +++ + +Description+Regular Expression that ensures a three-letter code+++ + + +Regular expression+^[A-Z][A-Z][A-Z]$+
+
+
+
+
+
+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.
+
+ Sites
+
+
+
+
+
+ Name
+ sites
+
+
+
+
+ Characteristic
+
+
+
+
+
+
+ Set
+
+
+ Has no order
+
+
+
+ Duplicates not allowed
+
+
+
+ Optional
+
+ Yes
+
+
+
+ In payload
+
+ Yes
+
+
+
+ Payload key
+ sites
+
+
+
+Reference
+
+
+ -
+
- https://confluence.catena-x.net/x/QkBHAw +
+
+
+
+ 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 (as designed)in the manufacturer`s dataspace. The Part ID does not reference a specific instance of a part and thus should 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
+
+
+
+
+
+
+Part ID as assigned by the manufacturer of the part. The Part ID identifies the part (as designed)in the customer`s dataspace. The Part ID does not reference a specific instance of a part and thus should not be confused with the serial number.
+
+ Customer Part ID
+
+
+
+
+
+ Name
+ customerPartId
+
+
+
+ Characteristic
+
+
+
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string
+
+
+
+
+
+ Example
+ PRT-12345
+
+
+
+ Optional
+
+ Yes
+
+
+
+ In payload
+
+ Yes
+
+
+
+
+Payload key
+ customerPartId
+
+
+
+
+
+
+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
+
+
+
+
+
+
+Name of the part as assigned by the customer
+
+ Name at Customer
+
+
+
+
+
+ Name
+ nameAtCustomer
+
+
+
+ Characteristic
+
+
+
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string
+
+
+
+
+
+ Example
+ side element A
+
+
+
+ Optional
+
+ Yes
+
+
+
+ In payload
+
+ Yes
+
+
+
+
+Payload key
+ nameAtCustomer
+
+
+
+
+
+
+Property describing the classification of a part.
+
+ Part Classification
+
+
+
+
+
+ Name
+ partClassification
+
+
+
+
+ Characteristic
+
+
+
+
+
+
+ SortedSet
+
+
+ Has a certain order
+
+
+
+ Duplicates not allowed
+
+
+
+ Optional
+
+ Yes
+
+
+
+ In payload
+
+ Yes
+
+
+
+
+Payload key
+ partClassification
+
+
+
+
+
+ Site Entity
+
+ Describes the ID and function of a site for the associated part in the AsBuilt context(e.g. SerialPart, Batch, jIS).
+
+
+
+
+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
+
+
+
+
+
+
+ Trait
+
+
+
+ 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
+
+
+Constraints
+
+
+-
+
-
++ +++ BPNS Regular Expression ++ +++ + +Description+The provided regular expression ensures that the BPNS is composed of prefix 'BPNS', 10 digits and two alphanumeric letters.+++ + + +Regular expression+^BPNS[a-zA-Z0-9]{12}$+
+
+
+
+
+
+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
+
+ Third party licenses
+
+
+
+