Developer Documentation
  • Documentation Overview
  • Development Introduction
  • Getting Started
  • Fundamentals
    • Deploy an App via Pre-defined Sidecar
      • Sidecar Tutorial: Server-side
      • Sidecar Tutorial: Client-side
      • Sidecar Tutorial: Docker & Deploy
    • Deploy an App with Eureka
    • Design Guidance
  • Authentication
    • Accessing data exposed by the platform
    • Single Sign-On
      • Angular
      • Vue
      • Java Spring: Accepting JWT
      • Python Django: Accepting JWT
    • User and Role Identification
  • APIs | Data Integration
    • Submodel Index
    • Masterdata
    • Transactional data
  • Docker Information
    • Ruby Stack
    • Golang Stack
    • Node JS Stack
    • Java Spring Stack
    • Python Stack
  • Connect to the Platform
    • Integrate using Eureka Rest APIs
    • Use our Pre-built sidecar
    • Production deployment
  • Add-on Features
    • IApps-Navigation
  • Testing
  • FAQs | Troubleshooting
  • Registration
    • Application pre-requisites
      • Basic Requirements
    • Register Developer Account
    • Submit basic application info
    • Onboard Application
      • Submit Appstore details
        • App basic information
      • Configure Application
        • App Permission
        • App Data
        • AAS Instance
        • Licensing
        • Access Rights
        • Account Info
        • Terms Of Use
        • Pricing
      • Publish and test
        • Deploy
        • Register into Service Discovery
    • Publish to Marketplace
  • User Experience
  • The business model - How do I get paid?
  • References
    • IndustryApps - Intro
    • What is an Asset Administration Shell?
    • What is ECLASS?
      • How is ECLASS and Concept dictionary are used
    • Industry 4.0 standards
    • Customer Terms of Use
      • Subscription Order
    • Solution provider Terms of Use
      • Contract regions
      • Submission Form ( Solution provider)
Powered by GitBook
On this page
  • Product
  • Tool
  • Machine
  • Company
  • Site
  • User
  1. APIs | Data Integration

Submodel Index

PreviousAPIs | Data IntegrationNextMasterdata

Last updated 2 years ago

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

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

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

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

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

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

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