Skip to content

Asset Management Service – Basic Asset Types

This section lists the available basic asset types. They can be recognized by the tenant ID core, as in core.basicdevice.

The following general properties are available on most basic asset types:

Property Description
parentTypeId The ID of the asset type from which this one was derived
instantiable Indicates if instances can be created from this type.
Asset types, which are not instantiable are also referred to as abstract types.
scope Indicates if an asset type is available to all tenants (public) or only to the tenant it was created in.
All basic asset types have a public scope. The scope of asset types created in a tenant is automatically set to private. The scope cannot be changed.

For restrictions on the values of individual properties, refer to the API Specification.

Basic Asset

The basic asset type is the base/root type of the Asset Management Service. Every asset type is inherited from this type. The basic asset type is an abstract types, so it is not possible to create assets from it.

Code example:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
{
  "parentTypeId": null,
  "instantiable": false,
  "tenantId": "core",
  "name": "BasicAsset",
  "description": "Base type for the Asset Management Service.",
  "scope": "public",
  "variables": [
    {
    "name": "externalId",
    "unit": null,
    "searchable": true,
    "defaultValue": null,
    "dataType": "STRING",
    "length": 255
    }
  ],
  "aspects": [],
  "fileAssignments": [],
  "etag": 1,
  "_links": {
    "self": {
    "href": "{link}"
    }
  },
  "id": "core.basicasset"
}

Basic Hierarchy

Basic hierarchy types are the template for all hierarchy types. They are used for modeling physical, fixed assets, like premises, factories, or equipment to structure assets hierarchically and reduce complexity. The basic hierarchy type is an abstract type, so it is not possible to create assets from it.

Code example:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
{
    "parentTypeId": "core.basicasset",
    "instantiable": false,
    "tenantId": "core",
    "name": "BasicHierarchy",
    "description": "Base hierarchy type for the Asset Management Service.",
    "scope": "public",
    "variables": [
      {
      "name": "hierarchyModel",
      "unit": null,
      "searchable": true,
      "defaultValue": null,
      "dataType": "STRING",
      "length": 255
      }
    ],
    "aspects": [
      {
      "name": "contactPoint",
      "aspectType": {
        "id": "core.contactpoint",
        "tenantId": "core",
        "name": "ContactPoint",
        "category": "static",
        "scope": "public",
        "description": "Contact point definition for basic asset hierarchy type.",
        "variables": [
        {
          "name": "telephoneNumber",
          "unit": null,
          "searchable": true,
          "qualityCode": false,
          "defaultValue": null,
          "dataType": "STRING",
          "length": 255
        },
        {
          "name": "faxNumber",
          "unit": null,
            "searchable": true,
          "qualityCode": false,
          "defaultValue": null,
          "dataType": "STRING",
          "length": 255
        },
        {
          "name": "email",
          "unit": null,
          "searchable": true,
          "qualityCode": false,
          "defaultValue": null,
          "dataType": "STRING",
          "length": 255
        },
        {
          "name": "contactType",
          "unit": null,
          "searchable": true,
          "qualityCode": false,
          "defaultValue": null,
          "dataType": "STRING",
          "length": 255
        }
        ],
        "etag": {etagValue},
        "_links": {
        "self": {
          "href": "{link}"
        }
        }
      }
      }
    ],
    "fileAssignments": [],
    "etag": {etagValue},
    "_links": {
      "self": {
      "href": "{link}"
      },
      "parent": {
      "href": "{link}"
      }
    },
    "id": "core.basichierarchy"
  }

Root Hierarchy

The root hierarchy type is the template for root types. These are used as the starting point of hierarchy models of a tenant's or subtenant's structure. When a tenant or subtenant is created, a root asset has to be created. All root types must be inherited from the root hierarchy type. The root hierarchy type is an abstract type, so it is not possible to create assets from it.

Users cannot create assets derived from a root hierarchy type via Asset Management REST calls.

Code example:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
{
    "parentTypeId": "core.basichierarchy",
    "instantiable": false,
    "tenantId": "core",
    "name": "RootHierarchy",
    "description": "Root type for asset hierarchy.",
    "scope": "public",
    "variables": [],
    "aspects": [],
    "fileAssignments": [],
    "etag": {etagValue},
    "_links": {
      "self": {
      "href": "{link}"
      },
      "parent": {
      "href": "{link}"
      }
    },
    "id": "core.roothierarchy"
}

Basic Enterprise

This is the template, from which a tenant's root asset must be created.

Code example:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
{
  "parentTypeId": "core.roothierarchy",
  "instantiable": true,
  "tenantId": "core",
  "name": "BasicEnterprise",
  "description": "Basic Enterprise type for the Asset Management Service",
  "scope": "public",
  "variables": [
    {
    "name": "sameAs",
    "unit": null,
    "searchable": true,
    "defaultValue": null,
    "dataType": "STRING",
    "length": 255
    },
    {
    "name": "legalName",
    "unit": null,
    "searchable": true,
    "defaultValue": null,
    "dataType": "STRING",
    "length": 255
    },
    {
    "name": "organizationType",
    "unit": null,
    "searchable": true,
    "defaultValue": null,
    "dataType": "STRING",
    "length": 255
    },
    {
    "name": "url",
    "unit": null,
    "searchable": true,
    "defaultValue": null,
    "dataType": "STRING",
    "length": 255
    }
  ],
  "aspects": [],
  "fileAssignments": [],
  "etag": {etagValue},
  "_links": {
    "self": {
    "href": "{link}"
    },
    "parent": {
    "href": "{link}"
    }
  },
  "id": "core.basicenterprise"
}

Basic Subtenant

This is the template, from which a subtenant's root asset must be created inside an existing tenant.

Code example:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
{
  "parentTypeId": "core.roothierarchy",
  "instantiable": true,
  "tenantId": "core",
  "name": "BasicSubtenant",
  "description": "SubTenant type for the Asset Management Service",
  "scope": "public",
  "variables": [
    {
    "name": "displayName",
    "unit": null,
    "searchable": true,
    "defaultValue": null,
    "dataType": "STRING",
    "length": 255
    }
  ],
  "aspects": [],
  "fileAssignments": [],
  "etag": {etagValue},
  "_links": {
    "self": {
    "href": "{link}"
    },
    "parent": {
    "href": "{link}"
    }
  },
  "id": "core.basicsubtenant"
}

Basic Site

The basic site type is used as a template for a site like a factory, office, etc. The Modeling Assets Section illustrates how to use the basic site type.

Code example:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
{
  "parentTypeId": "core.basichierarchy",
  "instantiable": true,
  "tenantId": "core",
  "name": "BasicSite",
  "description": "Site type for creating asset hierarchy levels.",
  "scope": "public",
  "variables": [],
  "aspects": [],
  "fileAssignments": [],
  "etag": {etagValue},
  "_links": {
    "self": {
    "href": "{link}"
    },
    "parent": {
    "href": "{link}"
    }
  },
  "id": "core.basicsite"
}

Basic Area

The basic area is used as a template for an area inside a site, like a bottling area in a beer factory or a floor in an office building.

Code example:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
{
  "parentTypeId": "core.basichierarchy",
  "instantiable": true,
  "tenantId": "core",
  "name": "BasicArea",
  "description": "Area type for creating asset hierarchy levels.",
  "scope": "public",
  "variables": [],
  "aspects": [],
  "fileAssignments": [],
  "etag": {etagValue},
  "_links": {
    "self": {
    "href": "{link}"
    },
    "parent": {
    "href": "{link}"
    }
  }
  "id": "core.basicarea"
}

Basic Agent

The basic agent type is the template for the different types of boxes or agents. The basic agent type is an abstract type, so it is not possible to create assets from it.

Code example:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
{
    "parentTypeId": "core.basicasset",
    "instantiable": false,
    "tenantId": "core",
    "name": "BasicAgent",
    "description": "Basic agent type for the Asset Management Service.",
    "scope": "public",
    "variables": [],
    "aspects": [
      {
        "name": "status",
        "aspectType": {
          "id": "core.agentstatus",
          "tenantId": "core",
          "name": "AgentOnlineStatus",
          "category": "dynamic",
          "scope": "public",
          "description": "Online status of an agent typed asset.",
          "variables": [
            {
              "name": "onlineStatus",
              "unit": null,
              "searchable": false,
              "qualityCode": false,
              "defaultValue": null,
              "dataType": "BOOLEAN",
              "length": null
            }
          ],
          "etag": {etagValue},
          "_links": {
            "self": {
              "href": "{link}"
            }
          }
        }
      }
    ],
    "fileAssignments": [],
    "etag": {etagValue},
    "_links": {
      "self": {
      "href": "{link}"
      },
      "parent": {
      "href": "{link}"
      }
  }
  "id": "core.basicagent"
}

MindConnect Nano

This asset type is the template for MindConnect Nano connectivity elements.

Code example:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
{
  "parentTypeId": "core.basicagent",
  "instantiable": true,
  "tenantId": "core",
  "name": "MindConnectNano",
  "description": "MindConnect Nano Agent asset type",
  "scope": "public",
  "variables": [],
  "aspects": [],
  "fileAssignments": [],
  "etag": {etagValue},
  "_links": {
    "self": {
    "href": "{link}"
    },
    "parent": {
    "href": "{link}"
    }
  },
  "id": "core.mcnano"
}

MindConnect Lib

This asset type is the template for MindConnect Library connectivity elements.

Code example:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
{
  "parentTypeId": "core.basicagent",
  "instantiable": true,
  "tenantId": "core",
  "name": "MindConnectLib",
  "description": "MindConnect Lib Agent asset type",
  "scope": "public",
  "variables": [],
  "aspects": [],
  "fileAssignments": [],
  "etag": {etagValue},
  "_links": {
    "self": {
    "href": "{link}"
    },
    "parent": {
    "href": "{link}"
    }
  },
  "id": "core.mclib"
}

MindConnect IoT 2040

This asset type is the template for MindConnect IoT 2040 connectivity elements.

Code example:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
{
  "parentTypeId": "core.basicagent",
  "instantiable": true,
  "tenantId": "core",
  "name": "MindConnectIoT2040",
  "description": "MindConnect IoT 2040 Agent asset type",
  "scope": "public",
  "variables": [],
  "aspects": [],
  "fileAssignments": [],
  "etag": {etagValue},
  "_links": {
    "self": {
    "href": "{link}"
    },
    "parent": {
    "href": "{link}"
    }
  },
  "id": "core.mciot2040"
}

MindConnect FB1500

Note

This basic type is deprecated. If you want to connect and represent the S7-1500 on MindSphere, use the MindConnect Library.

Code example:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
{
  "parentTypeId": "core.basicagent",
  "instantiable": true,
  "tenantId": "core",
  "name": "MindConnectFB1500",
  "description": "MindConnect FB 1500 Agent asset type",
  "scope": "public",
  "variables": [],
  "aspects": [],
  "fileAssignments": [],
  "etag": {etagValue},
  "_links": {
    "self": {
    "href": "{link}"
    },
    "parent": {
    "href": "{link}"
    }
  },
  "id": "core.mcfb1500"
}

MindConnect Integration

Code example:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
{
  "parentTypeId": "core.basicagent",
  "instantiable": true,
  "tenantId": "core",
  "name": "MindConnectIntegration",
  "description": "MindConnect Integration Agent asset type",
  "scope": "public",
  "variables": [],
  "aspects": [],
  "fileAssignments": [],
  "etag": {etagValue},
  "_links": {
    "self": {
    "href": "{link}"
    },
    "parent": {
    "href": "{link}"
    }
  },
  "id": "core.mcintegration"
}

Industrial Edge

Code example:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
{
  "parentTypeId": "core.basicagent",
  "instantiable": true,
  "tenantId": "core",
  "name": "IndustrialEdge",
  "description": "Industrial Edge Agent asset type",
  "scope": "public",
  "variables": [],
  "aspects": [],
  "fileAssignments": [],
  "etag": {etagValue},
  "_links": {
    "self": {
    "href": "{link}"
    },
    "parent": {
    "href": "{link}"
    }
  },
  "id": "core.industrialEdge"
}

Basic Device

The basic device type is the template for machines or other assets to collect data from. Every device asset type is inherited from the basic device type. The basic device type is an abstract asset type, so it is not possible to create assets from it.

Code example:

  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
{
    "parentTypeId": "core.basicasset",
    "instantiable": false,
    "tenantId": "core",
    "name": "BasicDevice",
    "description": "Basic device asset type for the Asset Management Service.",
    "scope": "public",
    "variables": [
      {
        "name": "manufacturer",
        "unit": null,
        "searchable": true,
        "defaultValue": null,
        "dataType": "STRING",
        "length": 255
      }
    ],
    "aspects": [
      {
        "name": "status",
        "aspectType": {
          "id": "core.assetstatus",
          "tenantId": "core",
          "name": "DeviceAssetStatus",
          "category": "static",
          "scope": "public",
          "description": "Status of a device typed asset.",
          "variables": [
            {
              "name": "connection_timestamp",
              "unit": null,
              "searchable": true,
              "qualityCode": false,
              "defaultValue": null,
              "dataType": "TIMESTAMP",
              "length": null
            },
            {
              "name": "connection",
              "unit": null,
              "searchable": true,
              "qualityCode": false,
              "defaultValue": null,
              "dataType": "INT",
              "length": null
            },
            {
              "name": "health_unconfirmed",
              "unit": null,
              "searchable": true,
              "qualityCode": false,
              "defaultValue": null,
              "dataType": "INT",
              "length": null
            },
            {
              "name": "health_timestamp",
              "unit": null,
              "searchable": true,
              "qualityCode": false,
              "defaultValue": null,
              "dataType": "TIMESTAMP",
              "length": null
            },
            {
              "name": "health",
              "unit": null,
              "searchable": true,
              "qualityCode": false,
              "defaultValue": null,
              "dataType": "INT",
              "length": null
            },
            {
              "name": "health_unconfirmed_timestamp",
              "unit": null,
              "searchable": true,
              "qualityCode": false,
              "defaultValue": null,
              "dataType": "TIMESTAMP",
              "length": null
            }
          ],
          "etag": {etagValue},
          "_links": {
            "self": {
              "href": "{link}"
            }
          }
        }
      }
    ],
    "fileAssignments": [],
    "etag": {etagValue},
    "_links": {
      "self": {
        "href": "{link}"
      },
      "parent": {
        "href": "{link}"
      }
    },
    "id": "core.basicdevice"
}

Basic Sinumerik Asset

The basic Sinumeric asset type is the template for Sinumerik devices. The basic Sinumerik asset type is an abstract asset type, so it is not possible to create assets from it.

Code example:

  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
{
  "parentTypeId": "core.basicdevice",
  "instantiable": false,
  "tenantId": "core",
  "name": "BasicSinumerikAsset",
  "description": "Basic asset type for Sinumerik devices.",
  "scope": "public",
  "variables": [],
  "aspects": [
    {
    "name": "CH1_BasicConfig",
    "aspectType": {
      "id": "core.sinumerikbasicconfig",
      "tenantId": "core",
      "name": "SinumerikBasicConfig",
      "category": "dynamic",
      "scope": "public",
      "description": "CH1_BasicConfig for Sinumerik typed asset.",
      "variables": [
      {
        "name": "NCProgramStatus",
        "unit": null,
        "searchable": true,
        "qualityCode": false,
        "defaultValue": null,
        "dataType": "DOUBLE",
        "length": null
      },
      {
        "name": "Spindleoverride",
        "unit": "%",
        "searchable": true,
        "qualityCode": false,
        "defaultValue": null,
        "dataType": "DOUBLE",
        "length": null
      },
      {
        "name": "StopCond",
        "unit": null,
        "searchable": true,
        "qualityCode": false,
        "defaultValue": null,
        "dataType": "DOUBLE",
        "length": null
      },
      {
        "name": "ProtectionLevel",
        "unit": null,
        "searchable": true,
        "qualityCode": false,
        "defaultValue": null,
        "dataType": "DOUBLE",
        "length": null
      },
      {
        "name": "NCProgram",
        "unit": null,
        "searchable": true,
        "qualityCode": false,
        "defaultValue": null,
        "dataType": "STRING",
        "length": 255
      },
      {
        "name": "Opmode",
        "unit": null,
        "searchable": true,
        "qualityCode": false,
        "defaultValue": null,
        "dataType": "DOUBLE",
        "length": null
      },
      {
        "name": "NrOfAlarms",
        "unit": null,
        "searchable": true,
        "qualityCode": false,
        "defaultValue": null,
        "dataType": "DOUBLE",
        "length": null
      },
      {
        "name": "Feedoverride",
        "unit": "%",
        "searchable": true,
        "qualityCode": false,
        "defaultValue": null,
        "dataType": "DOUBLE",
        "length": null
      }
      ],
      "etag": {etagValue},
      "_links": {
      "self": {
        "href": "{link}"
      }
      }
    }
    },
    {
    "name": "Alarms",
    "aspectType": {
      "id": "core.sinumerikbasicalarms",
      "tenantId": "core",
      "name": "SinumerikBasicAlarms",
      "category": "dynamic",
      "scope": "public",
      "description": "Alarms for Sinumerik typed asset.",
      "variables": [
      {
        "name": "CurrentAlarms",
        "unit": null,
        "searchable": true,
        "qualityCode": false,
        "defaultValue": null,
        "dataType": "BIG_STRING",
        "length": 100000
      }
      ],
      "etag": {etagValue},
      "_links": {
      "self": {
        "href": "{link}"
      }
      }
    }
    },
    {
    "name": "MachineModel",
    "aspectType": {
      "id": "core.sinumerikbasicmachinemodel",
      "tenantId": "core",
      "name": "SinumerikBasicMachineModel",
      "category": "dynamic",
      "scope": "public",
      "description": "Machinemodel for Sinumerik typed asset.",
      "variables": [
      {
        "name": "Data",
        "unit": null,
        "searchable": true,
        "qualityCode": false,
        "defaultValue": null,
        "dataType": "BIG_STRING",
        "length": 100000
      }
      ],
      "etag": {etagValue},
      "_links": {
      "self": {
        "href": "{link}"
      }
      }
    }
    },
    {
    "name": "CH1_MachineStatus",
    "aspectType": {
      "id": "core.sinumerikbasicmachinestatus",
      "tenantId": "core",
      "name": "SinumerikBasicMachineStatus",
      "category": "dynamic",
      "scope": "public",
      "description": "CH1_MachineStatus for Sinumerik typed asset.",
      "variables": [
      {
        "name": "MachineStatus",
        "unit": "%",
        "searchable": true,
        "qualityCode": false,
        "defaultValue": null,
        "dataType": "DOUBLE",
        "length": null
      }
      ],
      "etag": {etagValue},
      "_links": {
      "self": {
        "href": "{link}"
      }
      }
    }
    },
    {
    "name": "Startup",
    "aspectType": {
      "id": "core.sinumerikbasicstartup",
      "tenantId": "core",
      "name": "SinumerikBasicStartup",
      "category": "dynamic",
      "scope": "public",
      "description": "Startup for Sinumerik typed asset.",
      "variables": [
      {
        "name": "shutdownTime",
        "unit": null,
        "searchable": true,
        "qualityCode": false,
        "defaultValue": null,
        "dataType": "STRING",
        "length": 255
      },
      {
        "name": "bootTime",
        "unit": null,
        "searchable": true,
        "qualityCode": false,
        "defaultValue": null,
        "dataType": "STRING",
        "length": 255
      }
      ],
      "etag": {etagValue},
      "_links": {
      "self": {
        "href": "{link}"
      }
      }
    }
    },
    {
    "name": "AgentOnlineStatus",
    "aspectType": {
      "id": "core.agentstatus",
      "tenantId": "core",
      "name": "AgentOnlineStatus",
      "category": "dynamic",
      "scope": "public",
      "description": "Online status of an agent typed asset.",
      "variables": [
      {
        "name": "onlineStatus",
        "unit": null,
        "searchable": false,
        "qualityCode": false,
        "defaultValue": null,
        "dataType": "BOOLEAN",
        "length": null
      }
      ],
      "etag": {etagValue},
      "_links": {
      "self": {
        "href": "{link}"
      }
      }
    }
    }
  ],
  "fileAssignments": [],
  "etag": {etagValue},
  "_links": {
    "self": {
    "href": "{link}"
    },
    "parent": {
    "href": "{link}"
    }
  },
  "id": "core.basicsinumerikasset"
}

Basic Application

The basic application type is the template for applications, which ingest data into MindSphere. The basic application type is an abstract asset type, so it is not possible to create assets from it.

Code example:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
{
    "parentTypeId": "core.basicasset",
    "instantiable": false,
    "tenantId": "core",
    "name": "BasicApplication",
    "description": "Basic asset type for Applications",
    "scope": "public",
    "variables": [],
    "aspects": [],
    "fileAssignments": [],
    "etag": {etagValue},
    "_links": {
      "self": {
        "href": "{link}"
      },
      "parent": {
        "href": "{link}"
      }
    },
    "id": "core.basicapplication"
}

Edge Basic Application

This asset type is the template for all Edge applications. The Edge basic application type is an abstract asset type, so it is not possible to create assets from it.

Code example:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
{
  "parentTypeId": "core.basicapplication",
  "instantiable": false,
  "tenantId": "core",
  "name": "EdgeBasicApplication",
  "description": "Represents the root asset type for all edge applications",
  "scope": "public",
  "variables": [],
  "aspects": [
    {
    "name": "status",
    "aspectType": {
      "id": "core.assetstatus",
      "tenantId": "core",
      "name": "DeviceAssetStatus",
      "category": "static",
      "scope": "public",
      "description": "Status of a device typed asset.",
      "variables": [
      {
        "name": "connection_timestamp",
        "unit": null,
        "searchable": true,
        "qualityCode": false,
        "defaultValue": null,
        "dataType": "TIMESTAMP",
        "length": null
      },
      {
        "name": "connection",
        "unit": null,
        "searchable": true,
        "qualityCode": false,
        "defaultValue": null,
        "dataType": "INT",
        "length": null
      },
      {
        "name": "health_unconfirmed",
        "unit": null,
        "searchable": true,
        "qualityCode": false,
        "defaultValue": null,
        "dataType": "INT",
        "length": null
      },
      {
        "name": "health_timestamp",
        "unit": null,
        "searchable": true,
        "qualityCode": false,
        "defaultValue": null,
        "dataType": "TIMESTAMP",
        "length": null
      },
      {
        "name": "health",
        "unit": null,
        "searchable": true,
        "qualityCode": false,
        "defaultValue": null,
        "dataType": "INT",
        "length": null
      },
      {
        "name": "health_unconfirmed_timestamp",
        "unit": null,
        "searchable": true,
        "qualityCode": false,
        "defaultValue": null,
        "dataType": "TIMESTAMP",
        "length": null
      }
      ],
      "etag": {etagValue},
      "_links": {
      "self": {
        "href": "{link}"
      }
      }
    }
    }
  ],
  "fileAssignments": [],
  "etag": {etagValue},
  "_links": {
    "self": {
    "href": "{link}"
    },
    "parent": {
    "href": "{link}"
    }
  },
  "id": "core.edgebasicapplication"
}

Edge Analytics Application

This asset type is the template for the Edge Analytics Application present on the Edge device.

Code example:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
{
  "parentTypeId": "core.edgebasicapplication",
  "instantiable": true,
  "tenantId": "core",
  "name": "EdgeAnalyticsApplication",
  "description": "Represents the Edge Analytics Application present on the Edge device",
  "scope": "public",
  "variables": [],
  "aspects": [
    {
    "name": "EdgeAnalyticsApplicationStatus",
    "aspectType": {
      "id": "core.edgeanalyticsapplicationstatus",
      "tenantId": "core",
      "name": "EdgeAnalyticsApplicationStatus",
      "category": "dynamic",
      "scope": "public",
      "description": "Status of the Edge Analytics Application",
      "variables": [
      {
        "name": "CPU_usage",
        "unit": "%",
        "searchable": false,
        "qualityCode": false,
        "defaultValue": null,
        "dataType": "INT",
        "length": null
      },
      {
        "name": "Project_state",
        "unit": null,
        "searchable": false,
        "qualityCode": false,
        "defaultValue": null,
        "dataType": "BOOLEAN",
        "length": null
      },
      {
        "name": "Server_state",
        "unit": null,
        "searchable": false,
        "qualityCode": false,
        "defaultValue": null,
        "dataType": "BOOLEAN",
        "length": null
      }
      ],
      "etag": {etagValue},
      "_links": {
      "self": {
        "href": "{link}"
      }
      }
    }
    }
  ],
  "fileAssignments": [],
  "etag": {etagValue},
  "_links": {
    "self": {
    "href": "{link}"
    },
    "parent": {
    "href": "{link}"
    }
  },
  "id": "core.edgeanalyticsapplication"
}

Any questions left?

Ask the community


Except where otherwise noted, content on this site is licensed under the MindSphere Development License Agreement.