Asset Types API

Get AssetType by Id

Returns the specified asset type.

Request

GET api/v1/Tenants/{tenantId}/Namespaces/{namespaceId}/AssetTypes/{assetTypeId}

Parameters

string tenantId
Tenant identifier

string namespaceId
Namespace identifier

string assetTypeId
Asset type identifier

Response

The response includes a status code and a response body.

Example response body

HTTP 200 OK
Content-Type: application/json
{
    "Id": "HeaterType",
    "Name": "NameOfHeaterType",
    "Description": "This is the AssetType which represents a common heater device.",
    "Metadata": [
        {
            "Id": "MetadataId1",
            "Name": "ModelNumber",
            "Description": "This metadata indicates the model number of a given Asset.",
            "SdsTypeCode": "Double",
        }
    ],
    "TypeReferences": [
        {
            "StreamReferenceId": "TypeReferenceId1",
            "StreamReferenceName": "TemperatureData",
            "TypeId": "PI-Float32"
        }
    ]
}

Get AssetTypes

Returns a list of asset types and the total number of returned asset types, specified as Total-Count in the HTTP response header.

Request

GET api/v1/Tenants/{tenantId}/Namespaces/{namespaceId}/AssetTypes?skip={skip}&count={count}

Parameters

string tenantId
Tenant identifier

string namespaceId
Namespace identifier

[Optional] int skip
Optional parameter representing the zero-based offset of the first asset type to retrieve. If not specified, a default value of 0 is used.

[Optional] int count
Optional parameter, between 1 and 1000 (inclusive), that represents the maximum number of retrieved asset types. If not specified, the default is 100.

Response

The response includes a status code and a body.

Create AssetType

Creates a new asset type with a specified identifier.

Request

POST api/v1/Tenants/{tenantId}/Namespaces/{namespaceId}/AssetTypes/{assetTypeId}

Parameters

string tenantId
Tenant identifier

string namespaceId
Namespace identifier

string assetTypeId
Asset type identifier

Request body

An AssetType object

Example request body

To create an asset type with a specific identifier, use the API route with identifier. If this is used, you must specify a matching Id field for the AssetType object in the JSON object below.

 {
    "Id": "HeaterType",
    "Name": "NameOfHeaterType",
    "Description": "This is the AssetType which represents a common heater device.",
    "Metadata": [
        {
            "Id": "MetadataId1",
            "Name": "ModelNumber",
            "Description": "This metadata indicates the model number of a given Asset.",
            "SdsTypeCode": "Double"
        }
    ],
    "TypeReferences": [
        {
            "Id": "TypeReferenceId1",
            "Name": "TemperatureData",
            "TypeId": "PI-Float32"
        }
    ]
}

Response

The response includes a status code and a body.

Create AssetTypes (Bulk create)

Creates a new AssetTypes object.

Request

POST api/v1/Tenants/{tenantId}/Namespaces/{namespaceId}/Bulk/AssetTypes

Parameters

string tenantId
Tenant identifier

string namespaceId
Namespace identifier

Request body

A list of AssetType objects

Response

The response includes a status code and a body.

Create or Update AssetType

Creates or updates an asset type with a specified identifer.

When updating an asset type which is referenced by assets, the following behaviors may apply:

• Deleting a metadata value on the asset type removes the metadata value on the resolved asset of any referenced asset​s.
• Renaming a metadata value on the asset type renames the metadata value on the resolved asset of any referenced assets​.
• Renaming the stream reference name on the asset type renames the stream reference on the resolved asset of any referenced assets.

Request

PUT api/v1/Tenants/{tenantId}/Namespaces/{namespaceId}/AssetTypes/{assetTypeId} 

Parameters

string tenantId
Tenant identifier

string namespaceId
Namespace identifier

string assetTypeId
Asset type identifier

Request body

The newly created or updated AssetType object.

Response

The response includes a status code and a body.

Delete AssetType

Deletes an asset type with a specified identifier. An AssetType resource cannot be deleted if it is referenced by any assets unless the deleteAssets parameter is explicitly set to true.

Request

DELETE api/v1/Tenants/{tenantId}/Namespaces/{namespaceId}/AssetTypes/{assetTypeId}?deleteAssets={true|false}

Parameters

string tenantId
Tenant identifier

string namespaceId
Namespace identifier

string assetTypeId
Asset type identifier

[optional] bool deleteAssets
By default, this value is false and if there are assets based on this asset type, a 409 code is returned. If this value is set to true, then any assets based on this asset type will be deleted along with the asset type in this one call.

Caution: This action is not reversible.

Request body

None

Response

The response includes a status code and a body.