Industrial Asset Hub Base Read Schema
This schema defines the base classes needed for Industrial Asset Hub (IAH). The hereby defined classes provide a schema to model assets and devices (as a special asset subtype) and a vocabulary valid for the whole project and all stakeholders. They are very generic and abstract on purpose so that multiple different specializations can be derived from it without constraining them needlessly. The schema here is the 'read' schema and is therefore used to retrieve asset data from the IAH inventory. It is used by inventory's v2 GET /assets and /assets/{id} API. The json schema document can be accessed at https://industrial-assets.io/schemas/iah/base-schema/released/v1/iah-base-read.json
URI: https://industrial-assets.io/schemas/iah/base-schema/released/v1/iah-base-read.yaml
Name: iah-base-read
Classes
| Class | Description |
|---|---|
| AssetLink | Asset Link that can be used to interact with assets and can be reached by the... |
| AssetLocation | Attributes that help locate where an asset can be physically found |
| Akz | Plant Labeling System very well-established in Germany which helps locating a... |
| GeoLocation | Geographic coordinates in which an asset can be found |
| MountingLocation | Representation of the location of an asset in an automation environment, wher... |
| Okz | Plant Labeling System that is well-established in Germany and helps locate a ... |
| AssetOperation | Operations that can be performed on the asset |
| BackupOperation | Backup operation can be performed on the asset |
| ChangeModeOperation | Change mode operation can be performed on the asset |
| FactoryResetOperation | Factory reset operation can be performed on the asset |
| FirmwareUpdateOperation | Firmware update operation can be performed on the asset |
| MemoryResetOperation | Memory reset operation can be performed on the asset |
| ProgramUpdateOperation | Program update operation can be performed on the asset |
| ResetCommunicationParameterOperation | Reset communication parameter operation can be performed on the asset |
| RestoreOperation | Restore operation can be performed on the asset |
| TwoStepFirmwareUpdateOperation | Two step firmware update operation can be performed on the asset |
| ConnectionPoint | A connection point is a hardware or software interface that enables an asset ... |
| EthernetPort | A hardware ConnectionPoint that supports one of the Ethernet networking proto... |
| Ipv4Connectivity | Configuration of an IP port |
| Ipv6Connectivity | Configuration of an IP port |
| CustomProperty | A custom property is a key-value pair that can be used to store additional in... |
| FunctionalObject | A part of a system, and has a function whose realization contributes to the p... |
| Asset | An asset is the representation of a functional object with a technical functi... |
| Device | A device is a special type of asset that can be managed with some asset manag... |
| Gateway | Gateway as a software asset can be mapped using the class |
| SoftwareArtifact | Software asset |
| InstanceAnnotation | Key/value pair that can be used to add metadata to an object |
| OperatingMode | Operating mode of an asset |
| CirOperatingMode | Asset is in CIR (Configuration In Run) mode |
| DefectiveOperatingMode | Asset is defective |
| ErrorSearchOperatingMode | Asset is in error search mode |
| HaltOperatingMode | Asset is halted |
| LinkUpOperatingMode | Asset has an active network link |
| NoPowerOperatingMode | Asset has no power |
| NotSupportedOperatingMode | Asset is in a not supported operating mode |
| RunOdisOperatingMode | Asset is running with ODIS |
| RunOperatingMode | Asset is running |
| RunRedundantOperatingMode | Asset is running in redundant mode |
| StartupOperatingMode | Asset is starting up |
| StopFwUpdateOperatingMode | Asset is stopped due to a firmware update |
| StopOperatingMode | Asset is stopped |
| StopSelfInitializationOperatingMode | Asset is stopped during self-initialization |
| StopWithoutOdisOperatingMode | Asset is stopped without ODIS |
| UpdateOperatingMode | Asset is performing an update |
| Organization | An organization such as a school, NGO, corporation, club, etc |
| ProductInstanceInformation | |
| RelatedConnectionPoint | Relationship of a ConnectionPoint with another one |
| SchemaOrgProduct | Any offered product or service |
| Product | Any offered product or service that might have different versions for the sam... |
| SoftwareComponent | Any kind of software element that needs to be considered |
| RunningSoftwareComponent | Software component representing running software |
| SoftwareArtifactComponent | |
| Source | The source of the asset data |
| State | State in which a certain item be |
| ManagementState | Documents if the asset is being regarded (managed) by the asset management or... |
| ReachabilityState | Documents the reachability state of an asset based on when it was last reache... |
Slots
| Slot | Description |
|---|---|
| access_group | The access group of an asset |
| activation_flag | Attribute for specifying if the operation is available in terms of true or fa... |
| artifact | Reference to the software artifact asset |
| asset_links | List of asset links that are connected to the asset gateway |
| asset_operations | List of device management operations supported by an asset |
| connection_point_id | Reference to the related ConnectionPoint by providing its identifier |
| connection_point_type | Type designator that provides support for polymorphism using connection point... |
| connection_points | An asset might have a connection point that can be used to connect with the a... |
| custom_properties | A list of custom properties that can be used to store additional information ... |
| custom_relationship | Type of relationship in an unstructured format |
| description | A textual description of the item's purpose and use |
| elevation | The elevation of a location in meters (WGS 84) |
| functional_object_schema_url | URL of the schema that defines the functional object type |
| functional_object_type | Type designator that supports polymorphism using functional parts |
| id | The unique identifier of an asset |
| instance_annotations | Metadata associated with an object |
| ipv4_address | The IP v4 address of a device port |
| ipv6_address | The IP v6 address of a device port |
| ipv6_network_prefix | Prefix of the subnetwork in which the IP address is located |
| is_firmware | Flag indicating that the software artifact is provided by a hardware manufact... |
| key | The key of a custom property as uuid |
| last_modified_timestamp | The timestamp when the asset was last modified |
| latitude | The latitude of a location |
| location | Possible ways to know where an asset is located |
| location_identifier | String that provides the location of the plant |
| location_type | Type designator that provides support for polymorphism using location |
| longitude | The longitude of a location |
| mac_address | The MAC address of the port |
| management_state | A manage state is an attribute of an asset that specifies how an asset is bei... |
| manufacturer | The manufacturer of the product |
| manufacturer_product | A way to identify a product based on the manufacturer and the product identif... |
| mode_name | Name of the operating mode |
| name | The name of the item |
| network_mask | The mask that segregates IPs v4 belonging to the same sub-network from the re... |
| operating_mode | The current operating mode of the asset |
| operation_name | Name of a device management operation |
| plant_designation | String that provides the location of the device in the plant |
| product_family | The product family represents a group of related products that share common c... |
| product_id | The product identifiers, such as ISBN |
| product_instance_information | Information about the product instance |
| product_link | Link to identify a product |
| product_version | Some products might have different versions under the same product ID |
| reachability_state | A slot to track the last observed reachability state and when it was observed |
| related_connection_points | A connection point might rely on another connection point to work |
| responsible | The person inside the organization responsible for the asset |
| router_ipv4_address | The IPv4 address of the router (AKA gateway) corresponding to a IPv4 address |
| router_ipv6_address | The IP v6 address of the default IP v6 router (AKA gateway) |
| running_software_id | Identifier for a running software instance |
| serial_number | The serial number or any alphanumeric identifier of a particular product |
| slot_name | User-assigned name of the slot, within the specified rack, where the asset ca... |
| slot_number | Identification of the slot, within the specified rack, where the asset can be... |
| software_component_type | Type designator that supports polymorphism using software components |
| software_components | An asset can host software artifacts that might want to be tracked |
| source | The source of the asset data |
| state_timestamp | The timestamp when the state was recorded |
| state_value | The value of the state |
| station_number | Identification of the rack where the asset can be found |
| subslot_number | Identification of the subslot, within the specified slot, where the asset can... |
| type | The type of the source |
| value | The value of the source |
Enumerations
| Enumeration | Description |
|---|---|
| ManagementStateValues | Possible management states |
| ReachabilityStateValues | Possible reachability states |
| SourceTypeValues | Possible source types |
Types
| Type | Description |
|---|---|
| Boolean | A binary (true or false) value |
| Curie | a compact URI |
| Date | a date (year, month and day) in an idealized calendar |
| DateOrDatetime | Either a date or a datetime |
| Datetime | The combination of a date and time |
| Decimal | A real number with arbitrary precision that conforms to the xsd:decimal speci... |
| Double | A real number that conforms to the xsd:double specification |
| Float | A real number that conforms to the xsd:float specification |
| Integer | An integer |
| Jsonpath | A string encoding a JSON Path |
| Jsonpointer | A string encoding a JSON Pointer |
| Ncname | Prefix part of CURIE |
| Nodeidentifier | A URI, CURIE or BNODE that represents a node in a model |
| Objectidentifier | A URI or CURIE that represents an object in the model |
| Sparqlpath | A string encoding a SPARQL Property Path |
| String | A character string |
| Time | A time object represents a (local) time of day, independent of any particular... |
| Uri | a complete URI |
| Uriorcurie | a URI or a CURIE |
Subsets
| Subset | Description |
|---|---|
| Connectivity | Elements that are related to connectivity |
| DeviceInteraction | Elements that are related to interactions with the devices |
| IndustryDomain | Elements that are specifically relevant for the industry domain |
| MostRelevant | Entry elements for the Industrial Asset Hub (IAH) base schema |