From 7ae4733719664922db4f713810fe9d8cff4469db Mon Sep 17 00:00:00 2001 From: GitHub Actions Bot Date: Fri, 30 Aug 2024 10:30:08 +0000 Subject: [PATCH] Adding auto-generated artifacts for new models --- .../gen/BusinessPartnerCertificate-aas.xml | 1359 ++++++++++++++ .../BusinessPartnerCertificate-schema.json | 134 ++ .../2.0.0/gen/BusinessPartnerCertificate.aasx | Bin 0 -> 5082 bytes .../2.0.0/gen/BusinessPartnerCertificate.html | 1555 +++++++++++++++++ .../2.0.0/gen/BusinessPartnerCertificate.json | 23 + .../2.0.0/gen/BusinessPartnerCertificate.yml | 250 +++ 6 files changed, 3321 insertions(+) create mode 100644 io.catenax.shared.business_partner_certificate/2.0.0/gen/BusinessPartnerCertificate-aas.xml create mode 100644 io.catenax.shared.business_partner_certificate/2.0.0/gen/BusinessPartnerCertificate-schema.json create mode 100644 io.catenax.shared.business_partner_certificate/2.0.0/gen/BusinessPartnerCertificate.aasx create mode 100644 io.catenax.shared.business_partner_certificate/2.0.0/gen/BusinessPartnerCertificate.html create mode 100644 io.catenax.shared.business_partner_certificate/2.0.0/gen/BusinessPartnerCertificate.json create mode 100644 io.catenax.shared.business_partner_certificate/2.0.0/gen/BusinessPartnerCertificate.yml diff --git a/io.catenax.shared.business_partner_certificate/2.0.0/gen/BusinessPartnerCertificate-aas.xml b/io.catenax.shared.business_partner_certificate/2.0.0/gen/BusinessPartnerCertificate-aas.xml new file mode 100644 index 00000000..8115b3c8 --- /dev/null +++ b/io.catenax.shared.business_partner_certificate/2.0.0/gen/BusinessPartnerCertificate-aas.xml @@ -0,0 +1,1359 @@ + + + + + defaultAdminShell + + + en + defaultAdminShell + + + + urn:samm:io.catenax.business_partner_certificate:2.0.0#BusinessPartnerCertificate + + Type + + + + ModelReference + + + Submodel + urn:samm:io.catenax.business_partner_certificate:2.0.0#BusinessPartnerCertificate/submodel + + + + + + + + + BusinessPartnerCertificate + + + en + A business partner certifcate describes a certificate (eg ISO9001, IATF-16949) via a certifcate document of a Catena-X business partner + + + + urn:samm:io.catenax.business_partner_certificate:2.0.0#BusinessPartnerCertificate/submodel + Template + + ModelReference + + + ConceptDescription + urn:samm:io.catenax.business_partner_certificate:2.0.0#BusinessPartnerCertificate + + + + + + businessPartnerNumber + + + en + Business Partner Number + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.business_partner_certificate:2.0.0#businessPartnerNumber + + + + xs:string + + + + CertificateTypeEntity + + + en + Entity of a certificate type + + + + + en + Detailed entity of the certificate like IS09001:2015, IATF 16949:2015 or other, valid types are registered at BPN metadatacontroller + + + + + certificateType + + + en + Certificate type + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.business_partner_certificate:2.0.0#certificateType + + + + xs:string + + + + certificateVersion + + + en + Certificate version + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.business_partner_certificate:2.0.0#certificateVersion + + + + xs:string + + + + + + registrationNumber + + + en + Certificate registration number + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.business_partner_certificate:2.0.0#registrationNumber + + + + xs:string + + + + areaOfApplication + + + en + Area of application + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.business_partner_certificate:2.0.0#areaOfApplication + + + + xs:string + + + + enclosedSites + + + en + Enclosed sites + + + + + en + Additional sites covered by the certificate, which can be either BPNS or BPNA + + + true + DataElement + + + EnclosedSiteEntity + + + en + Enclosed Site Entity + + + + + en + Entity representing an enclosed site, can be BPNS or BPNA + + + + + enclosedSiteBpn + + + en + enclosedSite BPN + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.business_partner_certificate:2.0.0#enclosedSiteBpn + + + + xs:string + + + + areaOfApplication + + + en + Area of application + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.business_partner_certificate:2.0.0#areaOfApplication + + + + xs:string + + + + + + + + validFrom + + + en + Valid from + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.business_partner_certificate:2.0.0#validFrom + + + + xs:date + + + + validUntil + + + en + Valid until + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.business_partner_certificate:2.0.0#validUntil + + + + xs:date + + + + issuer + + + en + Issuing authority + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.business_partner_certificate:2.0.0#issuer + + + + xs:string + + + + trustLevel + + + en + Trust level + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.business_partner_certificate:2.0.0#trustLevel + + + + xs:string + + + + TrustValidatorEntitity + + + en + Trust validator entity + + + + + en + The BPN of the data service provider who validated the given certificate + + + + + validatorName + + + en + Validator name + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.business_partner_certificate:2.0.0#validatorName + + + + xs:string + + + + validatorBpn + + + en + Certifcate validator Bpn + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.business_partner_certificate:2.0.0#validatorBpn + + + + xs:string + + + + + + uploader + + + en + Certifcate uploader + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.business_partner_certificate:2.0.0#uploader + + + + xs:string + + + + documentID + + + en + Document ID + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.business_partner_certificate:2.0.0#documentID + + + + xs:string + + + + + + + + APPLICATION_CLASS + BusinessPartnerCertificate + + + en + Business Partner certificate + + + + + en + A business partner certifcate describes a certificate (eg ISO9001, IATF-16949) via a certifcate document of a Catena-X business partner + + + urn:samm:io.catenax.business_partner_certificate:2.0.0#BusinessPartnerCertificate + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Business Partner certificate + + + + + en + BusinessPartnerCertificate + + + + + en + A business partner certifcate describes a certificate (eg ISO9001, IATF-16949) via a certifcate document of a Catena-X business partner + + + + + + + + + businessPartnerNumber + + + en + Business Partner Number + + + urn:samm:io.catenax.business_partner_certificate:2.0.0#businessPartnerNumber + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Business Partner Number + + + + + en + businessPartnerNumber + + + STRING + + + en + The BPN of the certified legal entity + + + + + + + + + certificateType + + + en + Certificate type + + + urn:samm:io.catenax.business_partner_certificate:2.0.0#certificateType + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Certificate type + + + + + en + certificateType + + + STRING + + + en + Type of the certificate as defined on the document,valid types are registered at BPN metadatacontroller + + + + + + + + + certificateVersion + + + en + Certificate version + + + urn:samm:io.catenax.business_partner_certificate:2.0.0#certificateVersion + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Certificate version + + + + + en + certificateVersion + + + STRING + + + en + Version of the certificate as defined on the document, usually the specific version of a certification standard + + + + + + + + + type + + + en + Certificate type + + + urn:samm:io.catenax.business_partner_certificate:2.0.0#type + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Certificate type + + + + + en + type + + + STRING + + + en + Type of the certificate as defined on the document like IS09001, IATF 16949 or other + + + + + + + + + registrationNumber + + + en + Certificate registration number + + + urn:samm:io.catenax.business_partner_certificate:2.0.0#registrationNumber + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Certificate registration number + + + + + en + registrationNumber + + + STRING + + + en + Registration number of the certificate as defined on the certificate + + + + + + + + + areaOfApplication + + + en + Area of application + + + urn:samm:io.catenax.business_partner_certificate:2.0.0#areaOfApplication + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Area of application + + + + + en + areaOfApplication + + + STRING + + + en + Details on which areas / application types a certificate is valid for a company + + + + + + + + + enclosedSiteBpn + + + en + enclosedSite BPN + + + urn:samm:io.catenax.business_partner_certificate:2.0.0#enclosedSiteBpn + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + enclosedSite BPN + + + + + en + enclosedSiteBpn + + + STRING + + + en + The BPN of an enclosed site + + + + + + + + + areaOfApplication + + + en + Area of application + + + urn:samm:io.catenax.business_partner_certificate:2.0.0#areaOfApplication + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Area of application + + + + + en + areaOfApplication + + + STRING + + + en + Details on which areas / application types a certificate is valid for a company + + + + + + + + + enclosedSites + + + en + Enclosed sites + + + urn:samm:io.catenax.business_partner_certificate:2.0.0#enclosedSites + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Enclosed sites + + + + + en + enclosedSites + + + STRING + + + en + Additional sites covered by the certificate, which can be either BPNS or BPNA + + + + + + + + + validFrom + + + en + Valid from + + + urn:samm:io.catenax.business_partner_certificate:2.0.0#validFrom + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Valid from + + + + + en + validFrom + + + STRING + + + en + Valid from date as defined on the certificate. + + + + + + + + + validUntil + + + en + Valid until + + + urn:samm:io.catenax.business_partner_certificate:2.0.0#validUntil + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Valid until + + + + + en + validUntil + + + STRING + + + en + Valid valid until as defined on the certificate. If certificate never expires value until expected to be 9999-12-31 + + + + + + + + + issuer + + + en + Issuing authority + + + urn:samm:io.catenax.business_partner_certificate:2.0.0#issuer + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Issuing authority + + + + + en + issuer + + + STRING + + + en + The BPN of the issuing authority e.g. TUEV Sued + + + + + + + + + trustLevel + + + en + Trust level + + + urn:samm:io.catenax.business_partner_certificate:2.0.0#trustLevel + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Trust level + + + + + en + trustLevel + + + STRING + + + en + The trust level of the given certificate - none,low, high, trusted + + + + + + none + + ModelReference + + + DataElement + urn:samm:io.catenax.business_partner_certificate:2.0.0#TrustLevelValue:none + + + + + + low + + ModelReference + + + DataElement + urn:samm:io.catenax.business_partner_certificate:2.0.0#TrustLevelValue:low + + + + + + high + + ModelReference + + + DataElement + urn:samm:io.catenax.business_partner_certificate:2.0.0#TrustLevelValue:high + + + + + + trusted + + ModelReference + + + DataElement + urn:samm:io.catenax.business_partner_certificate:2.0.0#TrustLevelValue:trusted + + + + + + + + + + + + + validatorName + + + en + Validator name + + + urn:samm:io.catenax.business_partner_certificate:2.0.0#validatorName + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Validator name + + + + + en + validatorName + + + STRING + + + en + The optional name of the data service provider who validated the given certificate + + + + + + + + + validatorBpn + + + en + Certifcate validator Bpn + + + urn:samm:io.catenax.business_partner_certificate:2.0.0#validatorBpn + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Certifcate validator Bpn + + + + + en + validatorBpn + + + STRING + + + en + The BPN of the data service provider who validated the given certificate + + + + + + + + + validator + + + en + Validator + + + urn:samm:io.catenax.business_partner_certificate:2.0.0#validator + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Validator + + + + + en + validator + + + STRING + + + en + The BPN of the data service provider who validate the given certificate + + + + + + + + + uploader + + + en + Certifcate uploader + + + urn:samm:io.catenax.business_partner_certificate:2.0.0#uploader + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Certifcate uploader + + + + + en + uploader + + + STRING + + + en + The BPN of the business partner who originally provided the certifcate data or document e.g. Mercedes Benz AG + + + + + + + + + documentID + + + en + Document ID + + + urn:samm:io.catenax.business_partner_certificate:2.0.0#documentID + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Document ID + + + + + en + documentID + + + STRING + + + en + The id of the certificate document as stored by the data service provider for physical download via API + + + + + + + + + diff --git a/io.catenax.shared.business_partner_certificate/2.0.0/gen/BusinessPartnerCertificate-schema.json b/io.catenax.shared.business_partner_certificate/2.0.0/gen/BusinessPartnerCertificate-schema.json new file mode 100644 index 00000000..c1d61be0 --- /dev/null +++ b/io.catenax.shared.business_partner_certificate/2.0.0/gen/BusinessPartnerCertificate-schema.json @@ -0,0 +1,134 @@ +{ + "$schema" : "http://json-schema.org/draft-04/schema", + "description" : "A business partner certifcate describes a certificate (eg ISO9001, IATF-16949) via a certifcate document of a Catena-X business partner", + "type" : "object", + "components" : { + "schemas" : { + "urn_samm_io.catenax.shared.business_partner_number_2.0.0_BpnlTrait" : { + "type" : "string", + "description" : "The provided regular expression ensures that the BPNL is composed of prefix 'BPNL', 10 digits and two alphanumeric letters.", + "pattern" : "^BPNL[a-zA-Z0-9]{12}$" + }, + "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.business_partner_certificate_2.0.0_CertificateTypeEntity" : { + "description" : "Detailed entity of the certificate like IS09001:2015, IATF 16949:2015 or other, valid types are registered at BPN metadatacontroller", + "type" : "object", + "properties" : { + "certificateType" : { + "description" : "Type of the certificate as defined on the document,valid types are registered at BPN metadatacontroller", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text" + }, + "certificateVersion" : { + "description" : "Version of the certificate as defined on the document, usually the specific version of a certification standard", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text" + } + }, + "required" : [ "certificateType" ] + }, + "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.business_partner_certificate_2.0.0_EnclosedSiteEntity" : { + "description" : "Entity representing an enclosed site, can be BPNS or BPNA", + "type" : "object", + "properties" : { + "enclosedSiteBpn" : { + "description" : "The BPN of an enclosed site", + "$ref" : "#/components/schemas/urn_samm_io.catenax.shared.business_partner_number_2.0.0_BpnsTrait" + }, + "areaOfApplication" : { + "description" : "Details on which areas / application types a certificate is valid for a company", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text" + } + }, + "required" : [ "enclosedSiteBpn" ] + }, + "EnclosedSitesList" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/urn_samm_io.catenax.business_partner_certificate_2.0.0_EnclosedSiteEntity" + } + }, + "urn_samm_io.catenax.business_partner_certificate_2.0.0_Date" : { + "type" : "string", + "format" : "date", + "description" : "Describes a property which contains the date in english format." + }, + "urn_samm_io.catenax.business_partner_certificate_2.0.0_TrustLevelValue" : { + "type" : "string", + "description" : "The possible trust level values of certificate", + "enum" : [ "none", "low", "high", "trusted" ] + }, + "urn_samm_io.catenax.business_partner_certificate_2.0.0_TrustValidatorCharacteristic" : { + "description" : "The BPN of the data service provider who validated the given certificate", + "type" : "object", + "properties" : { + "validatorName" : { + "description" : "The optional name of the data service provider who validated the given certificate", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text" + }, + "validatorBpn" : { + "description" : "The BPN of the data service provider who validated the given certificate", + "$ref" : "#/components/schemas/urn_samm_io.catenax.shared.business_partner_number_2.0.0_BpnlTrait" + } + } + } + } + }, + "properties" : { + "businessPartnerNumber" : { + "description" : "The BPN of the certified legal entity ", + "$ref" : "#/components/schemas/urn_samm_io.catenax.shared.business_partner_number_2.0.0_BpnlTrait" + }, + "type" : { + "description" : "Type of the certificate as defined on the document like IS09001, IATF 16949 or other", + "$ref" : "#/components/schemas/urn_samm_io.catenax.business_partner_certificate_2.0.0_CertificateTypeEntity" + }, + "registrationNumber" : { + "description" : "Registration number of the certificate as defined on the certificate", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text" + }, + "areaOfApplication" : { + "description" : "Details on which areas / application types a certificate is valid for a company", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text" + }, + "enclosedSites" : { + "description" : "Additional sites covered by the certificate, which can be either BPNS or BPNA", + "$ref" : "#/components/schemas/EnclosedSitesList" + }, + "validFrom" : { + "description" : "Valid from date as defined on the certificate.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.business_partner_certificate_2.0.0_Date" + }, + "validUntil" : { + "description" : "Valid valid until as defined on the certificate. If certificate never expires value until expected to be 9999-12-31", + "$ref" : "#/components/schemas/urn_samm_io.catenax.business_partner_certificate_2.0.0_Date" + }, + "issuer" : { + "description" : "The BPN of the issuing authority e.g. TUEV Sued ", + "$ref" : "#/components/schemas/urn_samm_io.catenax.shared.business_partner_number_2.0.0_BpnlTrait" + }, + "trustLevel" : { + "description" : "The trust level of the given certificate - none,low, high, trusted", + "$ref" : "#/components/schemas/urn_samm_io.catenax.business_partner_certificate_2.0.0_TrustLevelValue" + }, + "validator" : { + "description" : "The BPN of the data service provider who validate the given certificate", + "$ref" : "#/components/schemas/urn_samm_io.catenax.business_partner_certificate_2.0.0_TrustValidatorCharacteristic" + }, + "uploader" : { + "description" : "The BPN of the business partner who originally provided the certifcate data or document e.g. Mercedes Benz AG", + "$ref" : "#/components/schemas/urn_samm_io.catenax.shared.business_partner_number_2.0.0_BpnlTrait" + }, + "documentID" : { + "description" : "The id of the certificate document as stored by the data service provider for physical download via API", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text" + } + }, + "required" : [ "businessPartnerNumber", "type", "registrationNumber", "validFrom", "validUntil", "trustLevel" ] +} \ No newline at end of file diff --git a/io.catenax.shared.business_partner_certificate/2.0.0/gen/BusinessPartnerCertificate.aasx b/io.catenax.shared.business_partner_certificate/2.0.0/gen/BusinessPartnerCertificate.aasx new file mode 100644 index 0000000000000000000000000000000000000000..c1030c44967f12557517cf6abdf812db8ec6c7e7 GIT binary patch literal 5082 zcmaJ_2Q-}979Pe7(K{h}FELsKi8h20!e}8%^xn(Wd+*W9C}H#%Ob8N0FNq$}1yQ4m zglJ(NdF!s5ci(+)|LZ^NKWm-6&%eKY_F3!u;3_~IN&p@n9-u{w@d@BJqqzDukau?S zuypb;*7k9+bT<<4c63P47_#dUBn+e~+J@!s3iiTgy8;spNalffN{>`2=JfQH7Xu$6 zx*pRWnkBU|ZKiJTiW09YWCsuueafVw#TRIh_8{`#U5w)r5TBO4<^s2qN_l!;c`7*-pu5G3=` zVIEK_>K%o&pV6|ZQH`5G4~p{N+6!2|#}Vw4GrmTyqyhHp3b$V}tlZNgNexg5ih!n0 zix!ZWcxJ5um3H+N@-xb!XT0z)?On{pXhf)Z_z*oG5qneZVoiBS2Wzu8)ef1@XMO_U zD!6##EA*sCSC~v=0j}o%3pIkP6~=Cs4(oE^Lq;`!~I`^@tt)xxdT&~_BRL1z>;hvQ5Z)aV$1$+@yzSzkR$zxg%d>-|rJB-u;}LpT9T+4b6Ps9P*lwT~ z+81Ih^nJw?6Hh>iT%G9|gmrxh87b+;<*CbdjWCRe&KEF;@loo3WM|8|n+3Nk*|R*W z=x9XjSl|*jRAJGVM2H34_Usp3uAeHhX=)~Gdb+DW=jItHYRV$M8u#-SEBjpu^-TNj z8a)%;FAwrvpYYN+wL69r>0Tyt<)JPc>N@V1$cj>sKR(=mv;|Et>++ivwm;HQ5N_AL zm97@DT6)xldks`olWN4*D;Qe-FHodcD@;w@y&>1bZD%)IYg?!9gM7+EeD4QGR0iKy zXv2nXb61Q5e}PX2Gs&X9@}RtW|2O#bf5!ZG1%8YCs~9@ZhMc;XNyCjny9_I0IA!Us zPU&t{W4P1pXG-;0FS#Esv>s|sH0Ckv-mSYheOa}vmYqq<-y(V&4`1MnLzTLcghX20O#sWJK@Xn03#z;(GyXj_+)N%dtL4vqCE#8u>yvLQ;1n zd!vTx%<)Ewwf>Y<41O}xIk=7Qeax-$LfvNED5h(i%g7OD16LVy{a>7~5&MPnRqsN~ z|J}~leY|Tl?>r|?9<iO8`aSQ!&5|7fy^-(%*0thGq0P5opX z#D1h4lg53o!P5RL1$ryCYsvqol|m}hr7yzACWePC1aoj?yT5v;^HSU;M&|V7tZ#R* z594z&b?VG?D=N=4NZID|2%3p?VZhq@=VqVoN5R~>y1+$O>uwnD{ygg+u5+DWJSL&vX$*}r;!mSfUst2Go78T z`_s_W330d|w66MmT9&x9pwtxjZ19tEL3+ehF^TPoIE8=Wg-!UOT(aO{y7PwY$=eYWNyvwo0k|*x35;>&AF1m}e65(;k?fv;Sjb>aT zh9{v3lV4ge2g>}e(nN7T$8U2C)9*)70lN=7Ww}W*-&t$W1gg>+Z4Te5r@;!EyWcWc zY~x0h<3R`xDmVaJ8k6SuD|^SfKK0QnH~m00Vk`K?@O~zH#`N0T{%=z~JJK4Hp_`>f zMx7_TGC_Y>Nn%-T@#DpEqLL;Mt_>-jPUM@&EZsEg$Mq;xhl!nT>eA;)8rC|XW?y`v zqr9eQt9aY>@&*K5*~O&h8vff+g*)!X>xmqk#i!-bBi_YD_iwio(vTsmNZvC`tfj`ya_Y zqNk{(t{c^jCW?47wQA{0um8Sf52^X#^2xODh&b)caJ;HU0rB(`kVjp+jpvLS<=dk8 zH$xR_3yk0IvoUGrCzRahToXt6mrW{)_y5r?8@@&{m zYSWK6nB&YSM|iA|&~3H$pRxw@4KFCLVxcG%(Mr+@!;jR{OiQgPygWN-8KbeDP zv)CMaiL#QEcV$(@%uE1xy})t>Plk~#G%)@=2VCcAW#skEU`f88Nt^ZI#ia0D=QrnO z?4=jy-VFxnsqUDLnQ`ZmN1I-i=W+3J@Jr3MqjZ@vK;Bqj=QOfv(JnIgZnhExI;{IZ z8S5~J;bNq+-E<<~zFwx7fcohQhf~FV8`V!1h&ic8+qm=Xc?fU2>1NP(hAhn`_GOpO z;C`f)eWQtD?@QIJgkuiIb*}8W3Vv+ z>a*}Em0KsXO;E+6{;aWfFz`c=V>z6d>K*39I3R_APEg>s;^j%Oo4sU{!#Xq{=kV0u z#ob-1h4vG1Tfl{ns}yYla%t>`e_6d6(`ZFwM8NEvl~rcRbN(szH-9MFiNf7yos+-S z2-kH<>6+S?z4|;OG&J_R%;+#)>*s&yTl<){xiEDP9WF11`QAwm;t6 zQlLJGcCUDqIWOi#uOvR5G}V2m*9N}-I3nWF8_uzC=PLA4)%*ZqF$XTihl$7pI$;nl0-j6MZ67!}xEF#rb;v#voZZ?$ zYWf2B0eafWj5z3W>3tpwOE19(5$e-oxu5B{-hSTrasGAti)vYdW%VRhQs>n6G|-&J z$9viPeFzjlA_gLH80MUn6huq-+2}^MGYht32ZLU~j>!m6?l{whVSp<7;IE6~Kfilz zClYwjrnI;*lb(ENZFrsHa+neY+{(cH+7)|Jxb?L@4;mfYHK8BOif;yF#*#(GdMt)? z<8v{1;;DSPlS$kjqnh&agpL*el?g%LcO*r;o`XXSl6u6I`dRlK!D@MZGKBif%5r8@02JoYK_)UBQ57m-G)_guRW8+(q zVLJe(;SZYj(S;pyd)ct&Fjmz>EWrm_%7G9*1Vgu;>lXo&XinPBJ@i18Jl;STpBIQe zUK2PDC@+llVA7E93bSaAq$F$w1Vgpt6f-%5$u5fs$ippeZhfJG%q$eh;&v{_kuhQO zB0^_A9nj~MkYp9!utH0W1a3!ntoxrCb%4U!ugg%*IcD4x9_-hhN~sR?HYrhsm~mkace5^-xM)@V>L5CjXX|Gx~^hyApPMcT#s@ASb5A zyyH?yt3vh_gm+R{s|MlyERv+Z42uckv-RxxdbrtXx=F~&@mFha{(Uf^Lh@%RjFR-b%=?%3xUg@iY#UM zlyf+``>gVwsQ%Xzl7m34gVuG$)2hCo2>Mkos@(yz&}b5}wySEe1tuI+EN`o!AapX_ z=Q_&)Sv&j6} zUU}<``4#NOdI1bl4r@qBFKUEks-~^6-(llldAT=kziKVUMOY4_nboL$qoM~5?AN;Y zLQLOOZV8NkSEu+~?{&ppIi1k?ig_DDK$`Poo<*GRCz%Y;t`zLVEU;OYz7CP4^=$b_5k1dD%Fof<0DN3RO2jmhcYqiQ7U$Y3 z5%UJ9*+A56aAB{tW^8Zr0$_lo&u|vGlC_G?ZDue4faU-I4uYBwf_`1h1L{(4J~91z z_kv|L^n!r^ToKF0_98Tps96$&eDZ3g?kD9JoNN~!HgSDzDAw?JWHpcW9 zJRu6Qb@v3oXcFZBoKS=-Bm&WfMfgrF-Nj1mSo{<4tH~Qalc|o zZkE>+$uY@DrAv@D0`u@)K+daqi^vA~v>2p=$%6xd(i)?er_3>)7ssXZsDcHKTzAG{ zzi&r!o*NV>`+8m%a;Ay0(ezbh_kQX=@*XdKP_>)O; zEYKPBG#j}I&F|E*FwTyR`;j( zKg$Y#5A^$qyJp{iSs(D9x%l5BRQ(3;^~wCpcCYgKuX74l0bO-1006#vLa!i#l3&mM E1xlsbdH?_b literal 0 HcmV?d00001 diff --git a/io.catenax.shared.business_partner_certificate/2.0.0/gen/BusinessPartnerCertificate.html b/io.catenax.shared.business_partner_certificate/2.0.0/gen/BusinessPartnerCertificate.html new file mode 100644 index 00000000..89dbe103 --- /dev/null +++ b/io.catenax.shared.business_partner_certificate/2.0.0/gen/BusinessPartnerCertificate.html @@ -0,0 +1,1555 @@ + + + + + + + + + + + + + + Documentation Business Partner certificate + + +
+
+
+
+

Aspect Model Business Partner certificate

+
urn:samm:io.catenax.business_partner_certificate:2.0.0#BusinessPartnerCertificate
+
+
+
+
+
+
+
+ +
+ + +
+ A business partner certifcate describes a certificate (eg ISO9001, IATF-16949) via a certifcate document of a Catena-X business partner +
+ + +
+

Overview

+
+
+
+
+ Aspect Model Diagram +
+
+
+ + +
+
+

Properties

+
+ +
+ +
+

Area of application

+
+ +Details on which areas / application types a certificate is valid for a company + +
+
Name
+
areaOfApplication
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
Development, Marketing und Sales and also Procurement for interior components
+
+ +
+
Optional
+
+ Yes
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
areaOfApplication
+
+ + +
+
+ +
+

Business Partner Number

+
+ +The BPN of the certified legal entity + +
+
Name
+
businessPartnerNumber
+
+ + + +
+
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
+
BPNL00000003AYRE
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
businessPartnerNumber
+
+ + +
+
Constraints
+
+
    +
  • +
    + +
    + BPNL Regular Expression +
    + +
    +
    Description
    +
    The provided regular expression ensures that the BPNL is composed of prefix 'BPNL', 10 digits and two alphanumeric letters.
    +
    + + +
    +
    Regular expression
    +
    ^BPNL[a-zA-Z0-9]{12}$
    +
    + +
    • +
+
+
+
+
+ +
+

Certifcate uploader

+
+ +The BPN of the business partner who originally provided the certifcate data or document e.g. Mercedes Benz AG + +
+
Name
+
uploader
+
+ + + +
+
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
+
BPNL00000003AYRE
+
+ +
+
Optional
+
+ Yes
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
uploader
+
+ + +
+
Constraints
+
+
    +
  • +
    + +
    + BPNL Regular Expression +
    + +
    +
    Description
    +
    The provided regular expression ensures that the BPNL is composed of prefix 'BPNL', 10 digits and two alphanumeric letters.
    +
    + + +
    +
    Regular expression
    +
    ^BPNL[a-zA-Z0-9]{12}$
    +
    + +
    • +
+
+
+
+
+ +
+

Certificate registration number

+
+ +Registration number of the certificate as defined on the certificate + +
+
Name
+
registrationNumber
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
12 198 54182 TMS
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
registrationNumber
+
+ + +
+
+ +
+

Certificate type

+
+ +Type of the certificate as defined on the document like IS09001, IATF 16949 or other + +
+
Name
+
type
+
+ + + +
+
Characteristic
+
+
+
+
SingleEntity
+
+
+
+ Type urn:samm:io.catenax.business_partner_certificate:2.0.0#CertificateTypeEntity + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
type
+
+ + +
+
+ +
+

Document ID

+
+ +The id of the certificate document as stored by the data service provider for physical download via API + +
+
Name
+
documentID
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
UUID--123456789
+
+ +
+
Optional
+
+ Yes
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
documentID
+
+ + +
+
+ +
+

Enclosed sites

+
+ +Additional sites covered by the certificate, which can be either BPNS or BPNA + +
+
Name
+
enclosedSites
+
+ + + +
+
Characteristic
+
+
+
+
List
+
+
+
Has a certain order
+
+
+
Duplicates allowed
+
+
+
+ Type urn:samm:io.catenax.business_partner_certificate:2.0.0#EnclosedSiteEntity + +
+
+
+
+
+ + +
+
Optional
+
+ Yes
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
enclosedSites
+
+ + +
+
+ +
+

Issuing authority

+
+ +The BPN of the issuing authority e.g. TUEV Sued + +
+
Name
+
issuer
+
+ + + +
+
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
+
BPNL00000023ZAVC
+
+ +
+
Optional
+
+ Yes
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
issuer
+
+ + +
+
Constraints
+
+
    +
  • +
    + +
    + BPNL Regular Expression +
    + +
    +
    Description
    +
    The provided regular expression ensures that the BPNL is composed of prefix 'BPNL', 10 digits and two alphanumeric letters.
    +
    + + +
    +
    Regular expression
    +
    ^BPNL[a-zA-Z0-9]{12}$
    +
    + +
    • +
+
+
+
+
+ +
+

Trust level

+
+ +The trust level of the given certificate - none,low, high, trusted + +
+
Name
+
trustLevel
+
+ + + +
+
Characteristic
+
+
+
+
Enumeration
+
+
+
Values
+
+
+
+
    +
  • none
    • +
  • low
    • +
  • high
    • +
  • trusted
    • +
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
high
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
trustLevel
+
+ + +
+
+ +
+

Valid from

+
+ +Valid from date as defined on the certificate. + +
+
Name
+
validFrom
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#date + +
+
+
+
+
+ +
+
Example
+
2023-01-25
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
validFrom
+
+ + +
+
+ +
+

Valid until

+
+ +Valid valid until as defined on the certificate. If certificate never expires value until expected to be 9999-12-31 + +
+
Name
+
validUntil
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#date + +
+
+
+
+
+ +
+
Example
+
2026-01-24
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
validUntil
+
+ + +
+
+ +
+

Validator

+
+ +The BPN of the data service provider who validate the given certificate + +
+
Name
+
validator
+
+ + + +
+
Characteristic
+
+
+
+
SingleEntity
+
+
+
+ Type urn:samm:io.catenax.business_partner_certificate:2.0.0#TrustValidatorEntitity + +
+
+
+
+
+ + +
+
Optional
+
+ Yes
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
validator
+
+ + +
+
+ + + +
+
+

Entities

+
+ +
+
+

Enclosed Site Entity

+
+
+ Entity representing an enclosed site, can be BPNS or BPNA +
+ +
+

Properties

+
+
+ +
+
enclosedSite BPN
+
+ +The BPN of an enclosed site + +
+
Name
+
enclosedSiteBpn
+
+ + + +
+
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
+
BPNS00000003AYRE
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
enclosedSiteBpn
+
+ + +
+
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}$
    +
    + +
    • +
+
+
+
+
+ +
+
Area of application
+
+ +Details on which areas / application types a certificate is valid for a company + +
+
Name
+
areaOfApplication
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
Development, Marketing und Sales and also Procurement for interior components
+
+ +
+
Optional
+
+ Yes
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
areaOfApplication
+
+ + +
+
+
+
+

Entity of a certificate type

+
+
+ Detailed entity of the certificate like IS09001:2015, IATF 16949:2015 or other, valid types are registered at BPN metadatacontroller +
+ +
+

Properties

+
+
+ +
+
Certificate type
+
+ +Type of the certificate as defined on the document,valid types are registered at BPN metadatacontroller + +
+
Name
+
certificateType
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
ISO9001
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
certificateType
+
+ + +
+
+ +
+
Certificate version
+
+ +Version of the certificate as defined on the document, usually the specific version of a certification standard + +
+
Name
+
certificateVersion
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
2015
+
+ +
+
Optional
+
+ Yes
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
certificateVersion
+
+ + +
+
+
+
+

Trust validator entity

+
+
+ The BPN of the data service provider who validated the given certificate +
+ +
+

Properties

+
+
+ +
+
Validator name
+
+ +The optional name of the data service provider who validated the given certificate + +
+
Name
+
validatorName
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
Data service provider X
+
+ +
+
Optional
+
+ Yes
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
validatorName
+
+ + +
+
+ +
+
Certifcate validator Bpn
+
+ +The BPN of the data service provider who validated the given certificate + +
+
Name
+
validatorBpn
+
+ + + +
+
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
+
BPNL00000007YREZ
+
+ +
+
Optional
+
+ Yes
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
validatorBpn
+
+ + +
+
Constraints
+
+
    +
  • +
    + +
    + BPNL Regular Expression +
    + +
    +
    Description
    +
    The provided regular expression ensures that the BPNL is composed of prefix 'BPNL', 10 digits and two alphanumeric letters.
    +
    + + +
    +
    Regular expression
    +
    ^BPNL[a-zA-Z0-9]{12}$
    +
    + +
    • +
+
+
+
+
+
+ +
+ Third party licenses + +
+ +
+ + +
+ + + \ No newline at end of file diff --git a/io.catenax.shared.business_partner_certificate/2.0.0/gen/BusinessPartnerCertificate.json b/io.catenax.shared.business_partner_certificate/2.0.0/gen/BusinessPartnerCertificate.json new file mode 100644 index 00000000..f404c561 --- /dev/null +++ b/io.catenax.shared.business_partner_certificate/2.0.0/gen/BusinessPartnerCertificate.json @@ -0,0 +1,23 @@ +{ + "businessPartnerNumber" : "BPNL00000003AYRE", + "enclosedSites" : [ { + "areaOfApplication" : "Development, Marketing und Sales and also Procurement for interior components", + "enclosedSiteBpn" : "BPNS00000003AYRE" + } ], + "registrationNumber" : "12 198 54182 TMS", + "uploader" : "BPNL00000003AYRE", + "validator" : { + "validatorName" : "Data service provider X", + "validatorBpn" : "BPNL00000007YREZ" + }, + "validUntil" : "2026-01-24", + "documentID" : "UUID--123456789", + "validFrom" : "2023-01-25", + "trustLevel" : "none", + "type" : { + "certificateVersion" : "2015", + "certificateType" : "ISO9001" + }, + "areaOfApplication" : "Development, Marketing und Sales and also Procurement for interior components", + "issuer" : "BPNL00000023ZAVC" +} \ No newline at end of file diff --git a/io.catenax.shared.business_partner_certificate/2.0.0/gen/BusinessPartnerCertificate.yml b/io.catenax.shared.business_partner_certificate/2.0.0/gen/BusinessPartnerCertificate.yml new file mode 100644 index 00000000..9b753081 --- /dev/null +++ b/io.catenax.shared.business_partner_certificate/2.0.0/gen/BusinessPartnerCertificate.yml @@ -0,0 +1,250 @@ +--- +openapi: 3.0.3 +info: + title: Business Partner certificate + version: v2 +servers: +- url: catenax.io/api/v2 + variables: + api-version: + default: v2 +paths: + /{tenant-id}/business-partner-certificate: + get: + tags: + - BusinessPartnerCertificate + operationId: getBusinessPartnerCertificate + 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/BusinessPartnerCertificate' + "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/BusinessPartnerCertificate' + totalItems: + type: number + totalPages: + type: number + pageSize: + type: number + currentPage: + type: number + urn_samm_io.catenax.shared.business_partner_number_2.0.0_BpnlTrait: + type: string + description: "The provided regular expression ensures that the BPNL is composed\ + \ of prefix 'BPNL', 10 digits and two alphanumeric letters." + pattern: "^BPNL[a-zA-Z0-9]{12}$" + 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.business_partner_certificate_2.0.0_CertificateTypeEntity: + description: "Detailed entity of the certificate like IS09001:2015, IATF 16949:2015\ + \ or other, valid types are registered at BPN metadatacontroller" + type: object + properties: + certificateType: + description: "Type of the certificate as defined on the document,valid types\ + \ are registered at BPN metadatacontroller" + $ref: '#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text' + certificateVersion: + description: "Version of the certificate as defined on the document, usually\ + \ the specific version of a certification standard" + $ref: '#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text' + required: + - certificateType + 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.business_partner_certificate_2.0.0_EnclosedSiteEntity: + description: "Entity representing an enclosed site, can be BPNS or BPNA" + type: object + properties: + enclosedSiteBpn: + description: The BPN of an enclosed site + $ref: '#/components/schemas/urn_samm_io.catenax.shared.business_partner_number_2.0.0_BpnsTrait' + areaOfApplication: + description: Details on which areas / application types a certificate is + valid for a company + $ref: '#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text' + required: + - enclosedSiteBpn + EnclosedSitesList: + type: array + items: + $ref: '#/components/schemas/urn_samm_io.catenax.business_partner_certificate_2.0.0_EnclosedSiteEntity' + urn_samm_io.catenax.business_partner_certificate_2.0.0_Date: + type: string + format: date + description: Describes a property which contains the date in english format. + urn_samm_io.catenax.business_partner_certificate_2.0.0_TrustLevelValue: + type: string + description: The possible trust level values of certificate + enum: + - none + - low + - high + - trusted + urn_samm_io.catenax.business_partner_certificate_2.0.0_TrustValidatorCharacteristic: + description: The BPN of the data service provider who validated the given certificate + type: object + properties: + validatorName: + description: The optional name of the data service provider who validated + the given certificate + $ref: '#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text' + validatorBpn: + description: The BPN of the data service provider who validated the given + certificate + $ref: '#/components/schemas/urn_samm_io.catenax.shared.business_partner_number_2.0.0_BpnlTrait' + BusinessPartnerCertificate: + description: "A business partner certifcate describes a certificate (eg ISO9001,\ + \ IATF-16949) via a certifcate document of a Catena-X business partner" + type: object + properties: + businessPartnerNumber: + description: 'The BPN of the certified legal entity ' + $ref: '#/components/schemas/urn_samm_io.catenax.shared.business_partner_number_2.0.0_BpnlTrait' + type: + description: "Type of the certificate as defined on the document like IS09001,\ + \ IATF 16949 or other" + $ref: '#/components/schemas/urn_samm_io.catenax.business_partner_certificate_2.0.0_CertificateTypeEntity' + registrationNumber: + description: Registration number of the certificate as defined on the certificate + $ref: '#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text' + areaOfApplication: + description: Details on which areas / application types a certificate is + valid for a company + $ref: '#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text' + enclosedSites: + description: "Additional sites covered by the certificate, which can be\ + \ either BPNS or BPNA" + $ref: '#/components/schemas/EnclosedSitesList' + validFrom: + description: Valid from date as defined on the certificate. + $ref: '#/components/schemas/urn_samm_io.catenax.business_partner_certificate_2.0.0_Date' + validUntil: + description: Valid valid until as defined on the certificate. If certificate + never expires value until expected to be 9999-12-31 + $ref: '#/components/schemas/urn_samm_io.catenax.business_partner_certificate_2.0.0_Date' + issuer: + description: 'The BPN of the issuing authority e.g. TUEV Sued ' + $ref: '#/components/schemas/urn_samm_io.catenax.shared.business_partner_number_2.0.0_BpnlTrait' + trustLevel: + description: "The trust level of the given certificate - none,low, high,\ + \ trusted" + $ref: '#/components/schemas/urn_samm_io.catenax.business_partner_certificate_2.0.0_TrustLevelValue' + validator: + description: The BPN of the data service provider who validate the given + certificate + $ref: '#/components/schemas/urn_samm_io.catenax.business_partner_certificate_2.0.0_TrustValidatorCharacteristic' + uploader: + description: The BPN of the business partner who originally provided the + certifcate data or document e.g. Mercedes Benz AG + $ref: '#/components/schemas/urn_samm_io.catenax.shared.business_partner_number_2.0.0_BpnlTrait' + documentID: + description: The id of the certificate document as stored by the data service + provider for physical download via API + $ref: '#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text' + required: + - businessPartnerNumber + - type + - registrationNumber + - validFrom + - validUntil + - trustLevel + 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' + BusinessPartnerCertificate: + content: + application/json: + schema: + $ref: '#/components/schemas/PagingSchema' + description: The request was successful. + requestBodies: + BusinessPartnerCertificate: + content: + application/json: + schema: + $ref: '#/components/schemas/BusinessPartnerCertificate'