Asset Types

The asset types API allows you to create, read, update, and delete asset types.

List Asset Types

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

Request

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

Parameters

string tenantId
Tenant identifier.

string namespaceId
Namespace identifier.

[optional] integer skip
Parameter representing the zero-based offset of the first object to retrieve. If unspecified, a default value of 0 is used.

[optional] integer count
Parameter representing the maximum number of objects to retrieve. If unspecified, a default value of 100 is used.

[optional] string filter
Filter expression for CreatedDate and LastModifiedDate properties.

Response

Response Headers

Example response body

200 Response

[
  {
    "Id": "SampleAssetType",
    "Description": "This is a sample asset type.",
    "Metadata": [
      {
        "Id": "fbd82b97-d29e-4022-968e-f8492cf86644",
        "Name": "ModelNumber",
        "Description": "This is a static attribute on the asset type which represents the model number.",
        "SdsTypeCode": "Double",
        "Value": 0.01
      }
    ],
    "TypeReferences": [
      {
        "StreamReferenceId": "f1bf9da2-3858-4bcd-bf93-e7c26ab0d28e",
        "StreamReferenceName": "ReferenceName",
        "TypeId": "PI-Float32"
      }
    ]
  },
  {
    "Id": "SecondSampleAssetType",
    "Description": "This is a second sample asset type.",
    "Metadata": [
      {
        "Id": "e79cdc54-5d94-4e78-ae1e-eb507c40737d",
        "Name": "ReleaseNumber",
        "Description": "This is a static attribute on the asset type which represents the model number.",
        "SdsTypeCode": "Double",
        "Value": 54.5
      }
    ],
    "TypeReferences": [
      {
        "StreamReferenceId": "d4f0f8b7-208a-4a6c-8a08-aec3577e0640",
        "StreamReferenceName": "ReferenceName",
        "TypeId": "PI-Int32"
      }
    ]
  }
]

400 Response (ErrorTemplate)

{
  "OperationId": "string",
  "Error": "string",
  "Resolution": "string",
  "Reason": "string",
  "property1": null,
  "property2": null
}

Head Asset Types

Returns the Headers corresponding to the GET AssetTypes call, including a collection ETag and, optionally, Total-Count. The collection ETag changes whenever an asset type is created, updated, or deleted.

Request

HEAD /api/v1/Tenants/{tenantId}/Namespaces/{namespaceId}/AssetTypes
?filter={filter}&includeTotalCount={includeTotalCount}

Parameters

string tenantId
Tenant identifier.

string namespaceId
Namespace identifier.

[optional] string filter
Filter expression for CreatedDate and LastModifiedDate properties.

[optional] boolean includeTotalCount
Optional Parameter. Default value is false. If set to true, Total-count header will be included in the returned headers. Total-Count refers to the number of asset types that the user has permission to access corresponding to an optional query.

Response

Response Headers

Create Asset Type

Create or update an asset type with a specified identifier.

Request

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

Parameters

string tenantId
Tenant identifier.

string namespaceId
Namespace identifier.

Request Body

Asset type to create.

{
  "Id": "SampleAssetType01",
  "Description": "This is a sample asset type.",
  "Metadata": [
    {
      "Id": "Id-fbd82b97-d29e-4022-968e",
      "Name": "ModelNumber",
      "Description": "This is a static attribute on the asset type which represents the model number.",
      "SdsTypeCode": "Double",
      "Value": 0.01
    }
  ],
  "TypeReferences": [
    {
      "StreamReferenceId": "f1bf9da2-3858-4bcd-bf93-e7c26ab0d28e",
      "StreamReferenceName": "ReferenceName",
      "TypeId": "PI-Float32"
    }
  ]
}

Response

Response Headers

Example response body

201 Response

{
  "Id": "SampleAssetType01",
  "Description": "This is a sample asset type.",
  "Metadata": [
    {
      "Id": "Id-fbd82b97-d29e-4022-968e",
      "Name": "ModelNumber",
      "Description": "This is a static attribute on the asset type which represents the model number.",
      "SdsTypeCode": "Double",
      "Value": 0.01
    }
  ],
  "TypeReferences": [
    {
      "StreamReferenceId": "f1bf9da2-3858-4bcd-bf93-e7c26ab0d28e",
      "StreamReferenceName": "ReferenceName",
      "TypeId": "PI-Float32"
    }
  ]
}

400 Response (ErrorTemplate)

{
  "OperationId": "string",
  "Error": "string",
  "Resolution": "string",
  "Reason": "string",
  "property1": null,
  "property2": null
}

Get Asset Type

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

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

Response Headers

Example response body

200 Response

{
  "Id": "SampleAssetType01",
  "Description": "This is a sample asset type.",
  "Metadata": [
    {
      "Id": "Id-fbd82b97-d29e-4022-968e",
      "Name": "ModelNumber",
      "Description": "This is a static attribute on the asset type which represents the model number.",
      "SdsTypeCode": "Double",
      "Value": 0.01
    }
  ],
  "TypeReferences": [
    {
      "StreamReferenceId": "f1bf9da2-3858-4bcd-bf93-e7c26ab0d28e",
      "StreamReferenceName": "ReferenceName",
      "TypeId": "PI-Float32"
    }
  ]
}

400 Response (ErrorTemplate)

{
  "OperationId": "string",
  "Error": "string",
  "Resolution": "string",
  "Reason": "string",
  "property1": null,
  "property2": null
}

Get Or Create Asset Type

Creates or updates an 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

Asset type to create.

{
  "Id": "SampleAssetType01",
  "Description": "This is a sample asset type.",
  "Metadata": [
    {
      "Id": "Id-fbd82b97-d29e-4022-968e",
      "Name": "ModelNumber",
      "Description": "This is a static attribute on the asset type which represents the model number.",
      "SdsTypeCode": "Double",
      "Value": 0.01
    }
  ],
  "TypeReferences": [
    {
      "StreamReferenceId": "f1bf9da2-3858-4bcd-bf93-e7c26ab0d28e",
      "StreamReferenceName": "ReferenceName",
      "TypeId": "PI-Float32"
    }
  ]
}

Response

Response Headers

Example response body

200 Response

{
  "Id": "SampleAssetType01",
  "Description": "This is a sample asset type.",
  "Metadata": [
    {
      "Id": "Id-fbd82b97-d29e-4022-968e",
      "Name": "ModelNumber",
      "Description": "This is a static attribute on the asset type which represents the model number.",
      "SdsTypeCode": "Double",
      "Value": 0.01
    }
  ],
  "TypeReferences": [
    {
      "StreamReferenceId": "f1bf9da2-3858-4bcd-bf93-e7c26ab0d28e",
      "StreamReferenceName": "ReferenceName",
      "TypeId": "PI-Float32"
    }
  ]
}

201 Response

{
  "Id": "SampleAssetType01",
  "Description": "This is a sample asset type.",
  "Metadata": [
    {
      "Id": "Id-fbd82b97-d29e-4022-968e",
      "Name": "ModelNumber",
      "Description": "This is a static attribute on the asset type which represents the model number.",
      "SdsTypeCode": "Double",
      "Value": 0.01
    }
  ],
  "TypeReferences": [
    {
      "StreamReferenceId": "f1bf9da2-3858-4bcd-bf93-e7c26ab0d28e",
      "StreamReferenceName": "ReferenceName",
      "TypeId": "PI-Float32"
    }
  ]
}

400 Response (ErrorTemplate)

{
  "OperationId": "string",
  "Error": "string",
  "Resolution": "string",
  "Reason": "string",
  "property1": null,
  "property2": null
}

Create Or Update Asset Type

Creates or updates an asset type with a specified identifier.

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

Asset type to create or update.

{
  "Id": "SampleAssetType01",
  "Description": "This is a sample asset type.",
  "Metadata": [
    {
      "Id": "Id-fbd82b97-d29e-4022-968e",
      "Name": "ModelNumber",
      "Description": "This is a static attribute on the asset type which represents the model number.",
      "SdsTypeCode": "Double",
      "Value": 0.01
    }
  ],
  "TypeReferences": [
    {
      "StreamReferenceId": "f1bf9da2-3858-4bcd-bf93-e7c26ab0d28e",
      "StreamReferenceName": "ReferenceName",
      "TypeId": "PI-Float32"
    }
  ]
}

Response

Response Headers

Example response body

200 Response

{
  "Id": "SampleAssetType01",
  "Description": "This is a sample asset type.",
  "Metadata": [
    {
      "Id": "Id-fbd82b97-d29e-4022-968e",
      "Name": "ModelNumber",
      "Description": "This is a static attribute on the asset type which represents the model number.",
      "SdsTypeCode": "Double",
      "Value": 0.01
    }
  ],
  "TypeReferences": [
    {
      "StreamReferenceId": "f1bf9da2-3858-4bcd-bf93-e7c26ab0d28e",
      "StreamReferenceName": "ReferenceName",
      "TypeId": "PI-Float32"
    }
  ]
}

201 Response

{
  "Id": "SampleAssetType01",
  "Description": "This is a sample asset type.",
  "Metadata": [
    {
      "Id": "Id-fbd82b97-d29e-4022-968e",
      "Name": "ModelNumber",
      "Description": "This is a static attribute on the asset type which represents the model number.",
      "SdsTypeCode": "Double",
      "Value": 0.01
    }
  ],
  "TypeReferences": [
    {
      "StreamReferenceId": "f1bf9da2-3858-4bcd-bf93-e7c26ab0d28e",
      "StreamReferenceName": "ReferenceName",
      "TypeId": "PI-Float32"
    }
  ]
}

400 Response (ErrorTemplate)

{
  "OperationId": "string",
  "Error": "string",
  "Resolution": "string",
  "Reason": "string",
  "property1": null,
  "property2": null
}

Patch Asset Type

Performs a Patch operation on the asset type with the specified identifier. The request body is expected to be a JSON Patch (RFC 6902) document. For the purposes of Patch operations, TypeReferences and Metadata are treated as dictionaries keyed by their identifiers, even though these properties are lists in the underlying asset type model. This permits individual TypeReferences and Metadata items to be indexed by their identifiers in the operation path.

Request

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

Parameters

string tenantId
Tenant identifier.

string namespaceId
Namespace identifier.

string assetTypeId
Asset Type identifier.

Request Body

Asset Type patch document.

{
  "Operations": [
    {
      "value": null,
      "path": "string",
      "op": "string",
      "from": "string"
    }
  ]
}

Response

Example response body

200 Response

{
  "Id": "SampleAssetType01",
  "Description": "This is a sample asset type.",
  "Metadata": [
    {
      "Id": "Id-fbd82b97-d29e-4022-968e",
      "Name": "ModelNumber",
      "Description": "This is a static attribute on the asset type which represents the model number.",
      "SdsTypeCode": "Double",
      "Value": 0.01
    }
  ],
  "TypeReferences": [
    {
      "StreamReferenceId": "f1bf9da2-3858-4bcd-bf93-e7c26ab0d28e",
      "StreamReferenceName": "ReferenceName",
      "TypeId": "PI-Float32"
    }
  ]
}

400 Response (ErrorTemplate)

{
  "OperationId": "string",
  "Error": "string",
  "Resolution": "string",
  "Reason": "string",
  "property1": null,
  "property2": null
}

Delete Asset Type

Deletes asset type with a specified identifier.

Request

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

Parameters

string tenantId
Tenant identifier.

string namespaceId
Namespace identifier.

string assetTypeId
Asset type identifier.

[optional] boolean deleteAssets
Call should also delete all assets of this asset type. Default is false.

Response

Bulk Create Asset Types

Bulk creates asset types. Creates multiple asset types in a single call.

Request

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

Parameters

string tenantId
Tenant identifier.

string namespaceId
Namespace identifier.

Request Body

List of asset types you want to create.

Response

Example response body

200 Response (MultiStatusResultOfAssetTypeAndChildErrorTemplate)

{
  "Reason": "string",
  "Error": "string",
  "OperationId": "string",
  "Data": [
    {
      "Id": "SampleAssetType01",
      "Description": "This is a sample asset type.",
      "Metadata": [
        {
          "Id": "Id-fbd82b97-d29e-4022-968e",
          "Name": "ModelNumber",
          "Description": "This is a static attribute on the asset type which represents the model number.",
          "SdsTypeCode": "Double",
          "Value": 0.01
        }
      ],
      "TypeReferences": [
        {
          "StreamReferenceId": "f1bf9da2-3858-4bcd-bf93-e7c26ab0d28e",
          "StreamReferenceName": "ReferenceName",
          "TypeId": "PI-Float32"
        }
      ]
    }
  ],
  "ChildErrors": [
    {
      "OperationId": "string",
      "Error": "string",
      "Resolution": "string",
      "Reason": "string",
      "StatusCode": 0,
      "property1": null,
      "property2": null
    }
  ]
}

Get Asset Type Owner

Returns the owner of specified asset type.

Request

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

Parameters

string tenantId
Tenant identifier.

string namespaceId
Namespace identifier.

string assetTypeId
Asset type identifier.

Response

Example response body

200 Response

{
  "Type": 1,
  "TenantId": "55555555-5555-5555-5555-555555555555",
  "ObjectId": "44444444-4444-4444-4444-444444444444"
}

400 Response (ErrorTemplate)

{
  "OperationId": "string",
  "Error": "string",
  "Resolution": "string",
  "Reason": "string",
  "property1": null,
  "property2": null
}

Update Asset Type Owner

Updates the owner of specified asset type.

Request

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

Parameters

string tenantId
Tenant identifier.

string namespaceId
Namespace identifier.

string assetTypeId
Asset type identifier.

Request Body

Updated owner.

{
  "Type": 1,
  "TenantId": "55555555-5555-5555-5555-555555555555",
  "ObjectId": "44444444-4444-4444-4444-444444444444"
}

Response

Get Asset Type Acl

Returns the access control list of the specified asset type.

Request

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

Parameters

string tenantId
Tenant identifier.

string namespaceId
Namespace identifier.

string assetTypeId
Asset type identifier.

Response

Example response body

200 Response

{
  "RoleTrusteeAccessControlEntries": [
    {
      "Trustee": {
        "Type": 3,
        "ObjectId": "11111111-1111-1111-1111-111111111111"
      },
      "AccessRights": 3
    },
    {
      "Trustee": {
        "Type": 3,
        "ObjectId": "22222222-2222-2222-1111-111111111111"
      }
    }
  ]
}

400 Response (ErrorTemplate)

{
  "OperationId": "string",
  "Error": "string",
  "Resolution": "string",
  "Reason": "string",
  "property1": null,
  "property2": null
}

Update Asset Type Access Control

Updates the access control of the specified asset type.

Request

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

Parameters

string tenantId
Tenant identifier.

string namespaceId
Namespace identifier.

string assetTypeId
Asset type identifier.

Request Body

Updated ACL.

{
  "RoleTrusteeAccessControlEntries": [
    {
      "Trustee": {
        "Type": 3,
        "ObjectId": "11111111-1111-1111-1111-111111111111"
      },
      "AccessRights": 3
    },
    {
      "Trustee": {
        "Type": 3,
        "ObjectId": "22222222-2222-2222-1111-111111111111"
      }
    }
  ]
}

Response

List Asset Type Access Rights

Returns the access rights of specified asset type.

Request

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

Parameters

string tenantId
Tenant identifier.

string namespaceId
Namespace identifier.

string assetTypeId
Asset type identifier.

Response

Example response body

200 Response

[
  "Read",
  "Write",
  "Delete",
  "ManageAccessControl"
]

400 Response (ErrorTemplate)

{
  "OperationId": "string",
  "Error": "string",
  "Resolution": "string",
  "Reason": "string",
  "property1": null,
  "property2": null
}

Definitions

ErrorTemplate

Properties

{
  "OperationId": "string",
  "Error": "string",
  "Resolution": "string",
  "Reason": "string",
  "property1": null,
  "property2": null
}

AssetType

An asset type can be used to create multiple similar assets. A change to the asset type is reflected in all assets that are derived from the asset type.

Properties

{
  "Id": "SampleAssetType01",
  "Description": "This is a sample asset type.",
  "Metadata": [
    {
      "Id": "Id-fbd82b97-d29e-4022-968e",
      "Name": "ModelNumber",
      "Description": "This is a static attribute on the asset type which represents the model number.",
      "SdsTypeCode": "Double",
      "Value": 0.01
    }
  ],
  "TypeReferences": [
    {
      "StreamReferenceId": "f1bf9da2-3858-4bcd-bf93-e7c26ab0d28e",
      "StreamReferenceName": "ReferenceName",
      "TypeId": "PI-Float32"
    }
  ]
}

MetadataItem

An asset or asset type metadata is static information associated with a given asset. A given metadata contains a list of individual metadata values. There is no limit on the number of metadata values defined by an asset. An asset or asset type metadata does not stand alone. It must be specified within an asset or asset type object and, therefore, there are no direct API routes to asset or asset type metadata.

Properties

{
  "Id": "Sample Metadata identifier",
  "Name": "Max Pressure",
  "Description": "This metadata represents the maximum pressure of a given asset.",
  "SdsTypeCode": "Double",
  "Value": 11.2,
  "Uom": "newton"
}

SdsTypeCode

Enumerated Values

SdsTypeCode2

Enumerated Values

TypeReference

An asset type type reference represents dynamic stream data associated with an asset. The references must either be an SDS stream or an SDS stream view. Asset-centric data routes provide direct access to dynamic data for a given asset. There are no limitations on the number of references an asset may contain. However, an asset cannot contain multiple references to the same SDS stream. An asset reference does not stand alone. It must be specified within an asset object and, therefore, asset references do not have direct API routes.

Properties

{
  "StreamReferenceId": "Reference1",
  "StreamReferenceName": "ReferenceName",
  "TypeId": "PI-Float32"
}

StatusConfiguration

Status configuration is a property of an asset or asset type that defines the simple status of an asset or asset type.

Properties

{
  "DefinitionType": "StreamPropertyMapping",
  "Definition": {
    "StreamReferenceId": "StatusMappingOnAssetTypeCrudFunctionalTest_streamRef",
    "StreamPropertyId": "Value",
    "ValueStatusMappings": [
      {
        "Value": 3,
        "Status": "Bad",
        "DisplayName": "Bad"
      },
      {
        "Value": 1,
        "Status": "Good",
        "DisplayName": "Good"
      }
    ]
  }
}

StatusDefinitionType

Status definition type. Currently, only StreamPropertyMapping is supported.

Enumerated Values

MultiStatusResultOfAssetTypeAndChildErrorTemplate

A multi status result is returned to indicate a partial success.

Properties

{
  "Reason": "string",
  "Error": "string",
  "OperationId": "string",
  "Data": [
    {
      "Id": "SampleAssetType01",
      "Description": "This is a sample asset type.",
      "Metadata": [
        {
          "Id": "Id-fbd82b97-d29e-4022-968e",
          "Name": "ModelNumber",
          "Description": "This is a static attribute on the asset type which represents the model number.",
          "SdsTypeCode": "Double",
          "Value": 0.01
        }
      ],
      "TypeReferences": [
        {
          "StreamReferenceId": "f1bf9da2-3858-4bcd-bf93-e7c26ab0d28e",
          "StreamReferenceName": "ReferenceName",
          "TypeId": "PI-Float32"
        }
      ]
    }
  ],
  "ChildErrors": [
    {
      "OperationId": "string",
      "Error": "string",
      "Resolution": "string",
      "Reason": "string",
      "StatusCode": 0,
      "property1": null,
      "property2": null
    }
  ]
}

ChildErrorTemplate

Properties

{
  "OperationId": "string",
  "Error": "string",
  "Resolution": "string",
  "Reason": "string",
  "StatusCode": 0,
  "property1": null,
  "property2": null
}

JsonPatchDocumentOfPatchAssetType

Properties

{
  "Operations": [
    {
      "value": null,
      "path": "string",
      "op": "string",
      "from": "string"
    }
  ]
}

OperationOfPatchAssetType

Properties

{
  "value": null,
  "path": "string",
  "op": "string",
  "from": "string"
}

Trustee

Properties

{
  "Type": 1,
  "ObjectId": "string",
  "TenantId": "string"
}

TrusteeType

Enumerated Values

AccessControlList

Properties

{
  "RoleTrusteeAccessControlEntries": [
    {
      "Trustee": {
        "Type": 1,
        "ObjectId": "string",
        "TenantId": "string"
      },
      "AccessType": 0,
      "AccessRights": 0
    }
  ]
}

AccessControlEntry

Properties

{
  "Trustee": {
    "Type": 1,
    "ObjectId": "string",
    "TenantId": "string"
  },
  "AccessType": 0,
  "AccessRights": 0
}

AccessType

Enumerated Values