Submodel Index

The categories below indicate the available Submodel data that can be extracted from users depending on allowed permission authorisation by the given users. Each given category has a sub-category with a designated description of what each type provides in a JSON format.
Product
Nameplate
TechnicalData
OperationalData
Documentation
Identification
BasicData
Type
Description
ManufacturerName
Manufacturer Name
Address
Address information of a business partner
SerialNumber
Serial Number
ManufacturerProductDesignation
Short description of the product
YearOfConstruction
Year Of Construction
ManufacturerProductFamily
Manufacturer Product Family
Type
Description
FurtherInformation
Further information on the product, the validity of the information provided and this data record
Generalinformation
General information, for example ordering and manufacturer information
ProductClassifications
Product classifications by association of product classes with common classification systems
TechnicalProperties
Technical and product properties. Individual characteristics that describe the product and its technical properties
Type
Description
MQTTProtocol
Messaging protocol
OPC-UAProtocol
Messaging protocol
TAGS
Connection Tags
Type
Description
ECAD
ECAD
IMAGES
IMAGES
TechnicalDocuments
TECHNICAL DOCUMENTS
3DMODELS
3DMODELS
OperatingManuals
OPERATING MANUALS
Type
Description
Status
Product Status
Site
Site AAS
Company
Company AAS
PartName
Part Name
PartNumber
Part Number
ProductCode
Product Code
Type
Description
grossWeight
Gross Weight
ValidTo
Product valid until DATE
NetWeight
Net Weight
Tool
Nameplate
TechnicalData
OperationalData
Documentation
Identification
BasicData
Type
Description
ManufacturerName
Manufacturer Name
Address
Address information of a business partner
SerialNumber
Serial Number
ManufacturerProductDesignation
Short description of the product
YearOfConstruction
Year Of Construction
ManufacturerProductFamily
Manufacturer Product Family
Type
Description
FurtherInformation
Further information on the product, the validity of the information provided and this data record
Generalinformation
General information, for example ordering and manufacturer information
ProductClassifications
Product classifications by association of product classes with common classification systems
TechnicalProperties
Technical and product properties. Individual characteristics that describe the product and its technical properties
Type
Description
MQTTProtocol
Messaging protocol
OPC-UAProtocol
Messaging protocol
TAGS
Connection Tags
Type
Description
ECAD
ECAD
IMAGES
Images
TechnicalDocuments
TECHNICAL DOCUMENTS
3DMODELS
3D Models
OperatingManuals
OPERATING MANUALS
Type
Description
Site
Site AAS
Company
Company AAS
ToolName
Tool Name
ToolCode
Tool Code
Status
Tool Status
Type
Description
ProcessType
Process Type
LifeTime
Tool LifeTime
Dimensions
Tool Dimensions
Weight
Tool Weight
Machine
Nameplate
TechnicalData
OperationalData
Documentation
Identification
BasicData
Type
Description
ManufacturerName
Manufacturer Name
Address
Address information of a business partner
SerialNumber
Serial Number
ManufacturerProductDesignation
Short description of the product
YearOfConstruction
Year Of Construction
ManufacturerProductFamily
Manufacturer Product Family
Type
Description
FurtherInformation
Further information on the product, the validity of the information provided and this data record
Generalinformation
General information, for example ordering and manufacturer information
ProductClassifications
Product classifications by association of product classes with common classification systems
TechnicalProperties
Technical and product properties. Individual characteristics that describe the product and its technical properties
Type
Description
MQTTProtocol
Messaging protocol
OPC-UAProtocol
Messaging protocol
TAGS
Connection Tags
Type
Description
ECAD
ECAD
IMAGES
Images
TechnicalDocuments
Technical Documents
3DMODELS
3D Models
OperatingManuals
Operating Manuals
Type
Description
Status
Machine status
Site
Site AAS
Company
Company AAS
MachineName
Machine Name
MachineCode
Machine Code
MachineNumber
Machine Number
Type
Description
MachineSize
Machine Size
FirstWorkingDay
First Working Day
ProcessType
Process Type
ProductionLine
Machine Production Line
Company
Nameplate
TechnicalData
OperationalData
Documentation
Identification
Type
Description
ManufacturerName
Manufacturer Name
Address
Address information of a business partner
SerialNumber
Serial Number
ManufacturerProductDesignation
Short description of the product
YearOfConstruction
Year Of Construction
ManufacturerProductFamily
Manufacturer Product Family
Type
Description
FurtherInformation
Further information on the product, the validity of the information provided and this data record
Generalinformation
General information, for example ordering and manufacturer information
ProductClassifications
Product classifications by association of product classes with common classification systems
TechnicalProperties
Technical and product properties. Individual characteristics that describe the product and its technical properties
Type
Description
MQTTProtocol
Messaging protocol
OPC-UAProtocol
Messaging protocol
TAGS
Connection Tags
Type
Description
ECAD
ECAD
IMAGES
Images
TechnicalDocuments
Technical Documents
3DMODELS
3D Models
OperatingManuals
Operating Manuals
Type
Description
IndustrySegment
Industry Segment
CompanyName
Company Name
Country
Country location of Company
CompanyID
Company ID
Website
Company Website
Site
Nameplate
TechnicalData
OperationalData
Documentation
Identification
Type
Description
ManufacturerName
Manufacturer Name
Address
Address information of a business partner
SerialNumber
Serial Number
ManufacturerProductDesignation
Short description of the product
YearOfConstruction
Year Of Construction
ManufacturerProductFamily
Manufacturer Product Family
Type
Description
FurtherInformation
Further information on the product, the validity of the information provided and this data record
Generalinformation
General information, for example ordering and manufacturer information
ProductClassifications
Product classifications by association of product classes with common classification systems
TechnicalProperties
Technical and product properties. Individual characteristics that describe the product and its technical properties
Type
Description
MQTTProtocol
Messaging protocol
OPC-UAProtocol
Messaging protocol
TAGS
Connection Tags
Type
Description
ECAD
ECAD
IMAGES
Images
TechnicalDocuments
Technical Documents
3DMODELS
3D Models
OperatingManuals
Operating Manuals
Type
Description
Geotag
GeoTag
Company
Company AAS
Address
Address information of a business partner
GLN
GLN
SiteImage
Site Image
PlantName
Plant Name
PlantCode
Plant Code
PlantID
Plant ID
User
Nameplate
TechnicalData
OperationalData
Documentation
Identification
BasicData
Type
Description
ManufacturerName
Manufacturer Name
Address
Address information of a business partner
SerialNumber
Serial Number
ManufacturerProductDesignation
Short description of the product
YearOfConstruction
Year Of Construction
ManufacturerProductFamily
Manufacturer Product Family
Type
Description
FurtherInformation
Further information on the product, the validity of the information provided and this data record
Generalinformation
General information, for example ordering and manufacturer information
ProductClassifications
Product classifications by association of product classes with common classification systems
TechnicalProperties
Technical and product properties. Individual characteristics that describe the product and its technical properties
Type
Description
MQTTProtocol
Messaging protocol
OPC-UAProtocol
Messaging protocol
TAGS
Connection Tags
Type
Description
ECAD
ECAD
IMAGES
Images
TechnicalDocuments
Technical Documents
3DMODELS
3D Models
OperatingManuals
Operating Manuals
Type
Description
EmailId
User Email ID
Company
Company Name
DefaultSite
Default Site
FirstName
User First Name
UserID
User ID
Country
User Country
Sites
User Sites
LastName
User Last Name
Status
Status
Type
Description
AuthorisationType
Authorisation Type
GroupCode
Group Code

Type	Description
ManufacturerName	Manufacturer Name
Address	Address information of a business partner
SerialNumber	Serial Number
ManufacturerProductDesignation	Short description of the product
YearOfConstruction	Year Of Construction
ManufacturerProductFamily	Manufacturer Product Family

Type	Description
FurtherInformation	Further information on the product, the validity of the information provided and this data record
Generalinformation	General information, for example ordering and manufacturer information
ProductClassifications	Product classifications by association of product classes with common classification systems
TechnicalProperties	Technical and product properties. Individual characteristics that describe the product and its technical properties

Type	Description
MQTTProtocol	Messaging protocol
OPC-UAProtocol	Messaging protocol
TAGS	Connection Tags

Type	Description
ECAD	ECAD
IMAGES	IMAGES
TechnicalDocuments	TECHNICAL DOCUMENTS
3DMODELS	3DMODELS
OperatingManuals	OPERATING MANUALS

Type	Description
Status	Product Status
Site	Site AAS
Company	Company AAS
PartName	Part Name
PartNumber	Part Number
ProductCode	Product Code

Type	Description
grossWeight	Gross Weight
ValidTo	Product valid until DATE
NetWeight	Net Weight

Type	Description
ManufacturerName	Manufacturer Name
Address	Address information of a business partner
SerialNumber	Serial Number
ManufacturerProductDesignation	Short description of the product
YearOfConstruction	Year Of Construction
ManufacturerProductFamily	Manufacturer Product Family

Type	Description
FurtherInformation	Further information on the product, the validity of the information provided and this data record
Generalinformation	General information, for example ordering and manufacturer information
ProductClassifications	Product classifications by association of product classes with common classification systems
TechnicalProperties	Technical and product properties. Individual characteristics that describe the product and its technical properties

Type	Description
MQTTProtocol	Messaging protocol
OPC-UAProtocol	Messaging protocol
TAGS	Connection Tags

Type	Description
ECAD	ECAD
IMAGES	Images
TechnicalDocuments	TECHNICAL DOCUMENTS
3DMODELS	3D Models
OperatingManuals	OPERATING MANUALS

Type	Description
Site	Site AAS
Company	Company AAS
ToolName	Tool Name
ToolCode	Tool Code
Status	Tool Status

Type	Description
ProcessType	Process Type
LifeTime	Tool LifeTime
Dimensions	Tool Dimensions
Weight	Tool Weight

Type	Description
ManufacturerName	Manufacturer Name
Address	Address information of a business partner
SerialNumber	Serial Number
ManufacturerProductDesignation	Short description of the product
YearOfConstruction	Year Of Construction
ManufacturerProductFamily	Manufacturer Product Family

Type	Description
FurtherInformation	Further information on the product, the validity of the information provided and this data record
Generalinformation	General information, for example ordering and manufacturer information
ProductClassifications	Product classifications by association of product classes with common classification systems
TechnicalProperties	Technical and product properties. Individual characteristics that describe the product and its technical properties

Type	Description
MQTTProtocol	Messaging protocol
OPC-UAProtocol	Messaging protocol
TAGS	Connection Tags

Type	Description
ECAD	ECAD
IMAGES	Images
TechnicalDocuments	Technical Documents
3DMODELS	3D Models
OperatingManuals	Operating Manuals

Type	Description
Status	Machine status
Site	Site AAS
Company	Company AAS
MachineName	Machine Name
MachineCode	Machine Code
MachineNumber	Machine Number

Type	Description
MachineSize	Machine Size
FirstWorkingDay	First Working Day
ProcessType	Process Type
ProductionLine	Machine Production Line

Type	Description
ManufacturerName	Manufacturer Name
Address	Address information of a business partner
SerialNumber	Serial Number
ManufacturerProductDesignation	Short description of the product
YearOfConstruction	Year Of Construction
ManufacturerProductFamily	Manufacturer Product Family

Type	Description
FurtherInformation	Further information on the product, the validity of the information provided and this data record
Generalinformation	General information, for example ordering and manufacturer information
ProductClassifications	Product classifications by association of product classes with common classification systems
TechnicalProperties	Technical and product properties. Individual characteristics that describe the product and its technical properties

Type	Description
MQTTProtocol	Messaging protocol
OPC-UAProtocol	Messaging protocol
TAGS	Connection Tags

Type	Description
ECAD	ECAD
IMAGES	Images
TechnicalDocuments	Technical Documents
3DMODELS	3D Models
OperatingManuals	Operating Manuals

Type	Description
IndustrySegment	Industry Segment
CompanyName	Company Name
Country	Country location of Company
CompanyID	Company ID
Website	Company Website

Type	Description
ManufacturerName	Manufacturer Name
Address	Address information of a business partner
SerialNumber	Serial Number
ManufacturerProductDesignation	Short description of the product
YearOfConstruction	Year Of Construction
ManufacturerProductFamily	Manufacturer Product Family

Type	Description
FurtherInformation	Further information on the product, the validity of the information provided and this data record
Generalinformation	General information, for example ordering and manufacturer information
ProductClassifications	Product classifications by association of product classes with common classification systems
TechnicalProperties	Technical and product properties. Individual characteristics that describe the product and its technical properties

Type	Description
MQTTProtocol	Messaging protocol
OPC-UAProtocol	Messaging protocol
TAGS	Connection Tags

Type	Description
ECAD	ECAD
IMAGES	Images
TechnicalDocuments	Technical Documents
3DMODELS	3D Models
OperatingManuals	Operating Manuals

Type	Description
Geotag	GeoTag
Company	Company AAS
Address	Address information of a business partner
GLN	GLN
SiteImage	Site Image
PlantName	Plant Name
PlantCode	Plant Code
PlantID	Plant ID

Type	Description
ManufacturerName	Manufacturer Name
Address	Address information of a business partner
SerialNumber	Serial Number
ManufacturerProductDesignation	Short description of the product
YearOfConstruction	Year Of Construction
ManufacturerProductFamily	Manufacturer Product Family

Type	Description
FurtherInformation	Further information on the product, the validity of the information provided and this data record
Generalinformation	General information, for example ordering and manufacturer information
ProductClassifications	Product classifications by association of product classes with common classification systems
TechnicalProperties	Technical and product properties. Individual characteristics that describe the product and its technical properties

Type	Description
MQTTProtocol	Messaging protocol
OPC-UAProtocol	Messaging protocol
TAGS	Connection Tags

Type	Description
ECAD	ECAD
IMAGES	Images
TechnicalDocuments	Technical Documents
3DMODELS	3D Models
OperatingManuals	Operating Manuals

Type	Description
EmailId	User Email ID
Company	Company Name
DefaultSite	Default Site
FirstName	User First Name
UserID	User ID
Country	User Country
Sites	User Sites
LastName	User Last Name
Status	Status

Type	Description
AuthorisationType	Authorisation Type
GroupCode	Group Code

APIs | Data Integration

Masterdata

Last modified 8mo ago