assetmanagement.models package

Submodules

assetmanagement.models.add_asset_request module

Asset Management API

Service for configuring, reading and managing assets, asset ~ and aspect types. # noqa: E501

class AddAssetRequest(asset=None)

Bases: object

Attributes:

attribute_types (dict): The key is attribute name

and the value is attribute type.

attribute_map (dict): The key is attribute name

and the value is json key in definition.

asset

Gets the asset of this AddAssetRequest.

Returns:The asset of this AddAssetRequest. Return type:Asset

attribute_map = {'asset': 'asset'}

attribute_types = {'asset': 'Asset'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

assetmanagement.models.aspect module

Asset Management API

Service for configuring, reading and managing assets, asset ~ and aspect types. # noqa: E501

class Aspect(name=None, variables=None)

Bases: object

Attributes:

attribute_types (dict): The key is attribute name

and the value is attribute type.

attribute_map (dict): The key is attribute name

and the value is json key in definition.

attribute_map = {'name': 'name', 'variables': 'variables'}

attribute_types = {'name': 'str', 'variables': 'list[Variable]'}

name

Gets the name of this Aspect.

Returns:The name of this Aspect. Return type:str

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

variables

Gets the variables of this Aspect.

Returns:The variables of this Aspect. Return type:list[Variable]

assetmanagement.models.aspect_links module

Asset Management API

Service for configuring, reading and managing assets, asset ~ and aspect types. # noqa: E501

class AspectLinks(_self=None, asset=None, aspect_type=None)

Bases: object

Attributes:

attribute_types (dict): The key is attribute name

and the value is attribute type.

attribute_map (dict): The key is attribute name

and the value is json key in definition.

_self

Gets the _self of this AspectLinks.

Returns:The _self of this AspectLinks. Return type:AspectLinksSelf

aspect_type

Gets the aspect_type of this AspectLinks.

Returns:The aspect_type of this AspectLinks. Return type:AspectLinksAspectType

asset

Gets the asset of this AspectLinks.

Returns:The asset of this AspectLinks. Return type:AspectLinksAsset

attribute_map = {'_self': 'self', 'aspect_type': 'aspectType', 'asset': 'asset'}

attribute_types = {'_self': 'AspectLinksSelf', 'aspect_type': 'AspectLinksAspectType', 'asset': 'AspectLinksAsset'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

assetmanagement.models.aspect_links_aspect_type module

Asset Management API

Service for configuring, reading and managing assets, asset ~ and aspect types. # noqa: E501

class AspectLinksAspectType(href=None)

Bases: object

Attributes:

attribute_types (dict): The key is attribute name

and the value is attribute type.

attribute_map (dict): The key is attribute name

and the value is json key in definition.

attribute_map = {'href': 'href'}

attribute_types = {'href': 'str'}

href

Gets the href of this AspectLinksAspectType. Link to the origin aspect type of the aspect

Returns:The href of this AspectLinksAspectType. Return type:str

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

assetmanagement.models.aspect_links_asset module

Asset Management API

Service for configuring, reading and managing assets, asset ~ and aspect types. # noqa: E501

class AspectLinksAsset(href=None)

Bases: object

Attributes:

attribute_types (dict): The key is attribute name

and the value is attribute type.

attribute_map (dict): The key is attribute name

and the value is json key in definition.

attribute_map = {'href': 'href'}

attribute_types = {'href': 'str'}

href

Gets the href of this AspectLinksAsset. Link to the asset

Returns:The href of this AspectLinksAsset. Return type:str

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

assetmanagement.models.aspect_links_self module

Asset Management API

Service for configuring, reading and managing assets, asset ~ and aspect types. # noqa: E501

class AspectLinksSelf(href=None)

Bases: object

Attributes:

attribute_types (dict): The key is attribute name

and the value is attribute type.

attribute_map (dict): The key is attribute name

and the value is json key in definition.

attribute_map = {'href': 'href'}

attribute_types = {'href': 'str'}

href

Gets the href of this AspectLinksSelf. Link to the aspect

Returns:The href of this AspectLinksSelf. Return type:str

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

assetmanagement.models.aspect_list_resource module

Asset Management API

Service for configuring, reading and managing assets, asset ~ and aspect types. # noqa: E501

class AspectListResource(embedded=None, page=None, links=None)

Bases: object

Attributes:

attribute_types (dict): The key is attribute name

and the value is attribute type.

attribute_map (dict): The key is attribute name

and the value is json key in definition.

attribute_map = {'embedded': '_embedded', 'links': '_links', 'page': 'page'}

attribute_types = {'embedded': 'AspectListResourceEmbedded', 'links': 'PagingLinks', 'page': 'Page'}

embedded

Gets the embedded of this AspectListResource.

Returns:The embedded of this AspectListResource. Return type:AspectListResourceEmbedded

links

Gets the links of this AspectListResource.

Returns:The links of this AspectListResource. Return type:PagingLinks

page

Gets the page of this AspectListResource.

Returns:The page of this AspectListResource. Return type:Page

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

assetmanagement.models.aspect_list_resource_embedded module

Asset Management API

Service for configuring, reading and managing assets, asset ~ and aspect types. # noqa: E501

class AspectListResourceEmbedded(aspects=None)

Bases: object

Attributes:

attribute_types (dict): The key is attribute name

and the value is attribute type.

attribute_map (dict): The key is attribute name

and the value is json key in definition.

aspects

Gets the aspects of this AspectListResourceEmbedded.

Returns:The aspects of this AspectListResourceEmbedded. Return type:list[AspectResource]

attribute_map = {'aspects': 'aspects'}

attribute_types = {'aspects': 'list[AspectResource]'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

assetmanagement.models.aspect_resource module

Asset Management API

Service for configuring, reading and managing assets, asset ~ and aspect types. # noqa: E501

class AspectResource(aspect_type_id=None, holder_asset_id=None, name=None, category=None, description=None, variables=None, links=None)

Bases: object

Attributes:

attribute_types (dict): The key is attribute name

and the value is attribute type.

attribute_map (dict): The key is attribute name

and the value is json key in definition.

aspect_type_id

Gets the aspect_type_id of this AspectResource. ID of the Aspect type

Returns:The aspect_type_id of this AspectResource. Return type:str

attribute_map = {'aspect_type_id': 'aspectTypeId', 'category': 'category', 'description': 'description', 'holder_asset_id': 'holderAssetId', 'links': '_links', 'name': 'name', 'variables': 'variables'}

attribute_types = {'aspect_type_id': 'str', 'category': 'str', 'description': 'str', 'holder_asset_id': 'UniqueId', 'links': 'AspectLinks', 'name': 'str', 'variables': 'list[AspectVariable]'}

category

Gets the category of this AspectResource.

Returns:The category of this AspectResource. Return type:str

description

Gets the description of this AspectResource. The description of the aspect

Returns:The description of this AspectResource. Return type:str

holder_asset_id

Gets the holder_asset_id of this AspectResource.

Returns:The holder_asset_id of this AspectResource. Return type:UniqueId

links

Gets the links of this AspectResource.

Returns:The links of this AspectResource. Return type:AspectLinks

name

Gets the name of this AspectResource. Name of the aspect

Returns:The name of this AspectResource. Return type:str

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

variables

Gets the variables of this AspectResource.

Returns:The variables of this AspectResource. Return type:list[AspectVariable]

assetmanagement.models.aspect_type module

Asset Management API

Service for configuring, reading and managing assets, asset ~ and aspect types. # noqa: E501

class AspectType(name=None, category=None, scope='private', description=None, variables=None)

Bases: object

Attributes:

attribute_types (dict): The key is attribute name

and the value is attribute type.

attribute_map (dict): The key is attribute name

and the value is json key in definition.

attribute_map = {'category': 'category', 'description': 'description', 'name': 'name', 'scope': 'scope', 'variables': 'variables'}

attribute_types = {'category': 'str', 'description': 'str', 'name': 'str', 'scope': 'str', 'variables': 'list[AspectVariable]'}

category

Gets the category of this AspectType. If the aspect-type is used for static data or time-series. Cannot be changed once the aspect-type is created.

Returns:The category of this AspectType. Return type:str

description

Gets the description of this AspectType. The description of the aspect type

Returns:The description of this AspectType. Return type:str

name

Gets the name of this AspectType. Name of the aspect type. It has to be unique inside the tenant and cannot be changed later.

Returns:The name of this AspectType. Return type:str

scope

Gets the scope of this AspectType. Visibility of aspecttype. Setting this property to public makes it available to other tenants. Private types are only visible to the user’s own tenant. Currently only private types can be created.

Returns:The scope of this AspectType. Return type:str

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

variables

Gets the variables of this AspectType. Variables of the aspect-type. Variable names should be unique inside an aspect-type. Once a variable is added to the aspect that it cannot be renamed or removed. Only variables of static aspect-type can have default values.

Returns:The variables of this AspectType. Return type:list[AspectVariable]

assetmanagement.models.aspect_type_id module

Asset Management API

Service for configuring, reading and managing assets, asset ~ and aspect types. # noqa: E501

class AspectTypeId

Bases: object

Attributes:

attribute_types (dict): The key is attribute name

and the value is attribute type.

attribute_map (dict): The key is attribute name

and the value is json key in definition.

attribute_map = {}

attribute_types = {}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

assetmanagement.models.aspect_type_links module

Asset Management API

Service for configuring, reading and managing assets, asset ~ and aspect types. # noqa: E501

class AspectTypeLinks(_self=None)

Bases: object

Attributes:

attribute_types (dict): The key is attribute name

and the value is attribute type.

attribute_map (dict): The key is attribute name

and the value is json key in definition.

_self

Gets the _self of this AspectTypeLinks.

Returns:The _self of this AspectTypeLinks. Return type:RelSelf

attribute_map = {'_self': 'self'}

attribute_types = {'_self': 'RelSelf'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

assetmanagement.models.aspect_type_list_resource module

Asset Management API

Service for configuring, reading and managing assets, asset ~ and aspect types. # noqa: E501

class AspectTypeListResource(embedded=None, page=None, links=None)

Bases: object

Attributes:

attribute_types (dict): The key is attribute name

and the value is attribute type.

attribute_map (dict): The key is attribute name

and the value is json key in definition.

attribute_map = {'embedded': '_embedded', 'links': '_links', 'page': 'page'}

attribute_types = {'embedded': 'AspectTypeListResourceEmbedded', 'links': 'PagingLinks', 'page': 'Page'}

embedded

Gets the embedded of this AspectTypeListResource.

Returns:The embedded of this AspectTypeListResource. Return type:AspectTypeListResourceEmbedded

links

Gets the links of this AspectTypeListResource.

Returns:The links of this AspectTypeListResource. Return type:PagingLinks

page

Gets the page of this AspectTypeListResource.

Returns:The page of this AspectTypeListResource. Return type:Page

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

assetmanagement.models.aspect_type_list_resource_embedded module

Asset Management API

Service for configuring, reading and managing assets, asset ~ and aspect types. # noqa: E501

class AspectTypeListResourceEmbedded(aspect_types=None)

Bases: object

Attributes:

attribute_types (dict): The key is attribute name

and the value is attribute type.

attribute_map (dict): The key is attribute name

and the value is json key in definition.

aspect_types

Gets the aspect_types of this AspectTypeListResourceEmbedded.

Returns:The aspect_types of this AspectTypeListResourceEmbedded. Return type:list[AspectTypeResource]

attribute_map = {'aspect_types': 'aspectTypes'}

attribute_types = {'aspect_types': 'list[AspectTypeResource]'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

assetmanagement.models.aspect_type_resource module

Asset Management API

Service for configuring, reading and managing assets, asset ~ and aspect types. # noqa: E501

class AspectTypeResource(name=None, category=None, scope='private', description=None, variables=None, id=None, tenant_id=None, etag=None, links=None)

Bases: object

Attributes:

attribute_types (dict): The key is attribute name

and the value is attribute type.

attribute_map (dict): The key is attribute name

and the value is json key in definition.

attribute_map = {'category': 'category', 'description': 'description', 'etag': 'etag', 'id': 'id', 'links': '_links', 'name': 'name', 'scope': 'scope', 'tenant_id': 'tenantId', 'variables': 'variables'}

attribute_types = {'category': 'str', 'description': 'str', 'etag': 'ETag', 'id': 'AspectTypeId', 'links': 'AspectTypeLinks', 'name': 'str', 'scope': 'str', 'tenant_id': 'TenantId', 'variables': 'list[AspectVariable]'}

category

Gets the category of this AspectTypeResource. If the aspect-type is used for static data or time-series. Cannot be changed once the aspect-type is created.

Returns:The category of this AspectTypeResource. Return type:str

description

Gets the description of this AspectTypeResource. The description of the aspect type

Returns:The description of this AspectTypeResource. Return type:str

etag

Gets the etag of this AspectTypeResource.

Returns:The etag of this AspectTypeResource. Return type:ETag

id

Gets the id of this AspectTypeResource.

Returns:The id of this AspectTypeResource. Return type:AspectTypeId

links

Gets the links of this AspectTypeResource.

Returns:The links of this AspectTypeResource. Return type:AspectTypeLinks

name

Gets the name of this AspectTypeResource. Name of the aspect type. It has to be unique inside the tenant and cannot be changed later.

Returns:The name of this AspectTypeResource. Return type:str

scope

Gets the scope of this AspectTypeResource. Visibility of aspecttype. Setting this property to public makes it available to other tenants. Private types are only visible to the user’s own tenant. Currently only private types can be created.

Returns:The scope of this AspectTypeResource. Return type:str

tenant_id

Gets the tenant_id of this AspectTypeResource.

Returns:The tenant_id of this AspectTypeResource. Return type:TenantId

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

variables

Gets the variables of this AspectTypeResource. Variables of the aspect-type. Variable names should be unique inside an aspect-type. Once a variable is added to the aspect that it cannot be renamed or removed. Only variables of static aspect-type can have default values.

Returns:The variables of this AspectTypeResource. Return type:list[AspectVariable]

assetmanagement.models.aspect_variable module

Asset Management API

Service for configuring, reading and managing assets, asset ~ and aspect types. # noqa: E501

class AspectVariable(name=None, data_type=None, unit=None, searchable=False, length=None, default_value=None, quality_code=False)

Bases: object

Attributes:

attribute_types (dict): The key is attribute name

and the value is attribute type.

attribute_map (dict): The key is attribute name

and the value is json key in definition.

attribute_map = {'data_type': 'dataType', 'default_value': 'defaultValue', 'length': 'length', 'name': 'name', 'quality_code': 'qualityCode', 'searchable': 'searchable', 'unit': 'unit'}

attribute_types = {'data_type': 'str', 'default_value': 'str', 'length': 'int', 'name': 'str', 'quality_code': 'bool', 'searchable': 'bool', 'unit': 'str'}

data_type

Gets the data_type of this AspectVariable. Data type of the variable. BIG_STRING could only be used by variables in dynamic aspect-types. Cannot be changed.

Returns:The data_type of this AspectVariable. Return type:str

default_value

Gets the default_value of this AspectVariable. The default value of the variable. It must be compatible with the dataType! The default value will be inherited by the asset type’s child types and by the asset instantiating it. It can be defined in aspect types and asset types.

Returns:The default_value of this AspectVariable. Return type:str

length

Gets the length of this AspectVariable. The max length of the variable’s value. The length field is only used for variables of string or big_string dataType. Max length for string is 255 and max length for big_string 100000. Cannot be changed.

Returns:The length of this AspectVariable. Return type:int

name

Gets the name of this AspectVariable. Name of the variable. Once set cannot be changed. Reserved words (id, name, description, tenant, etag, scope, properties, propertySets, extends, variables, aspects, parentTypeId) cannot be used as variable names.

Returns:The name of this AspectVariable. Return type:str

quality_code

Gets the quality_code of this AspectVariable. Indicates whether the variable has quality code. Cannot be changed.

Returns:The quality_code of this AspectVariable. Return type:bool

searchable

Gets the searchable of this AspectVariable. Indicates whether sorting and filtering is allowed on this variable. Only usable for static properties. Cannot be changed.

Returns:The searchable of this AspectVariable. Return type:bool

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

unit

Gets the unit of this AspectVariable. Unit of measurement. Cannot be changed.

Returns:The unit of this AspectVariable. Return type:str

assetmanagement.models.asset module

Asset Management API

Service for configuring, reading and managing assets, asset ~ and aspect types. # noqa: E501

class Asset(name=None, external_id=None, description=None, location=None, variables=None, aspects=None, file_assignments=None, type_id=None, parent_id=None, timezone=None, twin_type=None)

Bases: object

Attributes:

attribute_types (dict): The key is attribute name

and the value is attribute type.

attribute_map (dict): The key is attribute name

and the value is json key in definition.

aspects

Gets the aspects of this Asset.

Returns:The aspects of this Asset. Return type:list[Aspect]

attribute_map = {'aspects': 'aspects', 'description': 'description', 'external_id': 'externalId', 'file_assignments': 'fileAssignments', 'location': 'location', 'name': 'name', 'parent_id': 'parentId', 'timezone': 'timezone', 'twin_type': 'twinType', 'type_id': 'typeId', 'variables': 'variables'}

attribute_types = {'aspects': 'list[Aspect]', 'description': 'str', 'external_id': 'str', 'file_assignments': 'list[FileAssignment]', 'location': 'Location', 'name': 'str', 'parent_id': 'UniqueId', 'timezone': 'Timezone', 'twin_type': 'TwinType', 'type_id': 'AssetTypeId', 'variables': 'list[Variable]'}

description

Gets the description of this Asset. The description of the asset

Returns:The description of this Asset. Return type:str

external_id

Gets the external_id of this Asset. The id given by the user

Returns:The external_id of this Asset. Return type:str

file_assignments

Gets the file_assignments of this Asset.

Returns:The file_assignments of this Asset. Return type:list[FileAssignment]

location

Gets the location of this Asset.

Returns:The location of this Asset. Return type:Location

name

Gets the name of this Asset. Name of the asset

Returns:The name of this Asset. Return type:str

parent_id

Gets the parent_id of this Asset.

Returns:The parent_id of this Asset. Return type:UniqueId

timezone

Gets the timezone of this Asset.

Returns:The timezone of this Asset. Return type:Timezone

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

twin_type

Gets the twin_type of this Asset.

Returns:The twin_type of this Asset. Return type:TwinType

type_id

Gets the type_id of this Asset.

Returns:The type_id of this Asset. Return type:AssetTypeId

variables

Gets the variables of this Asset.

Returns:The variables of this Asset. Return type:list[Variable]

assetmanagement.models.asset_links module

Asset Management API

Service for configuring, reading and managing assets, asset ~ and aspect types. # noqa: E501

class AssetLinks(_self=None, parent=None, children=None, variables=None, aspects=None, t2_tenant=None, location=None)

Bases: object

Attributes:

attribute_types (dict): The key is attribute name

and the value is attribute type.

attribute_map (dict): The key is attribute name

and the value is json key in definition.

_self

Gets the _self of this AssetLinks.

Returns:The _self of this AssetLinks. Return type:AssetLinksSelf

aspects

Gets the aspects of this AssetLinks.

Returns:The aspects of this AssetLinks. Return type:AssetLinksAspects

attribute_map = {'_self': 'self', 'aspects': 'aspects', 'children': 'children', 'location': 'location', 'parent': 'parent', 't2_tenant': 't2Tenant', 'variables': 'variables'}

attribute_types = {'_self': 'AssetLinksSelf', 'aspects': 'AssetLinksAspects', 'children': 'AssetLinksChildren', 'location': 'AssetLinksLocation', 'parent': 'AssetLinksParent', 't2_tenant': 'AssetLinksT2Tenant', 'variables': 'AssetLinksVariables'}

children

Gets the children of this AssetLinks.

Returns:The children of this AssetLinks. Return type:AssetLinksChildren

location

Gets the location of this AssetLinks.

Returns:The location of this AssetLinks. Return type:AssetLinksLocation

parent

Gets the parent of this AssetLinks.

Returns:The parent of this AssetLinks. Return type:AssetLinksParent

t2_tenant

Gets the t2_tenant of this AssetLinks.

Returns:The t2_tenant of this AssetLinks. Return type:AssetLinksT2Tenant

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

variables

Gets the variables of this AssetLinks.

Returns:The variables of this AssetLinks. Return type:AssetLinksVariables

assetmanagement.models.asset_links_aspects module

Asset Management API

Service for configuring, reading and managing assets, asset ~ and aspect types. # noqa: E501

class AssetLinksAspects(href=None)

Bases: object

Attributes:

attribute_types (dict): The key is attribute name

and the value is attribute type.

attribute_map (dict): The key is attribute name

and the value is json key in definition.

attribute_map = {'href': 'href'}

attribute_types = {'href': 'str'}

href

Gets the href of this AssetLinksAspects. URL to get the aspect structure of the asset

Returns:The href of this AssetLinksAspects. Return type:str

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

assetmanagement.models.asset_links_children module

Asset Management API

Service for configuring, reading and managing assets, asset ~ and aspect types. # noqa: E501

class AssetLinksChildren(href=None)

Bases: object

Attributes:

attribute_types (dict): The key is attribute name

and the value is attribute type.

attribute_map (dict): The key is attribute name

and the value is json key in definition.

attribute_map = {'href': 'href'}

attribute_types = {'href': 'str'}

href

Gets the href of this AssetLinksChildren. URL to get the children of the asset

Returns:The href of this AssetLinksChildren. Return type:str

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

assetmanagement.models.asset_links_location module

Asset Management API

Service for configuring, reading and managing assets, asset ~ and aspect types. # noqa: E501

class AssetLinksLocation(href=None)

Bases: object

Attributes:

attribute_types (dict): The key is attribute name

and the value is attribute type.

attribute_map (dict): The key is attribute name

and the value is json key in definition.

attribute_map = {'href': 'href'}

attribute_types = {'href': 'str'}

href

Gets the href of this AssetLinksLocation. URL to update or delete the location of the asset

Returns:The href of this AssetLinksLocation. Return type:str

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

assetmanagement.models.asset_links_parent module

Asset Management API

Service for configuring, reading and managing assets, asset ~ and aspect types. # noqa: E501

class AssetLinksParent(href=None)

Bases: object

Attributes:

attribute_types (dict): The key is attribute name

and the value is attribute type.

attribute_map (dict): The key is attribute name

and the value is json key in definition.

attribute_map = {'href': 'href'}

attribute_types = {'href': 'str'}

href

Gets the href of this AssetLinksParent. URL to get the parent of the asset

Returns:The href of this AssetLinksParent. Return type:str

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

assetmanagement.models.asset_links_self module

Asset Management API

Service for configuring, reading and managing assets, asset ~ and aspect types. # noqa: E501

class AssetLinksSelf(href=None)

Bases: object

Attributes:

attribute_types (dict): The key is attribute name

and the value is attribute type.

attribute_map (dict): The key is attribute name

and the value is json key in definition.

attribute_map = {'href': 'href'}

attribute_types = {'href': 'str'}

href

Gets the href of this AssetLinksSelf. URL to get the asset

Returns:The href of this AssetLinksSelf. Return type:str

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

assetmanagement.models.asset_links_t2_tenant module

Asset Management API

Service for configuring, reading and managing assets, asset ~ and aspect types. # noqa: E501

class AssetLinksT2Tenant(href=None)

Bases: object

Attributes:

attribute_types (dict): The key is attribute name

and the value is attribute type.

attribute_map (dict): The key is attribute name

and the value is json key in definition.

attribute_map = {'href': 'href'}

attribute_types = {'href': 'str'}

href

Gets the href of this AssetLinksT2Tenant. URL to get the end-customer of the asset

Returns:The href of this AssetLinksT2Tenant. Return type:str

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

assetmanagement.models.asset_links_variables module

Asset Management API

Service for configuring, reading and managing assets, asset ~ and aspect types. # noqa: E501

class AssetLinksVariables(href=None)

Bases: object

Attributes:

attribute_types (dict): The key is attribute name

and the value is attribute type.

attribute_map (dict): The key is attribute name

and the value is json key in definition.

attribute_map = {'href': 'href'}

attribute_types = {'href': 'str'}

href

Gets the href of this AssetLinksVariables. URL to get the variable definitions of the asset

Returns:The href of this AssetLinksVariables. Return type:str

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

assetmanagement.models.asset_list_resource module

Asset Management API

Service for configuring, reading and managing assets, asset ~ and aspect types. # noqa: E501

class AssetListResource(embedded=None, page=None, links=None)

Bases: object

Attributes:

attribute_types (dict): The key is attribute name

and the value is attribute type.

attribute_map (dict): The key is attribute name

and the value is json key in definition.

attribute_map = {'embedded': '_embedded', 'links': '_links', 'page': 'page'}

attribute_types = {'embedded': 'AssetListResourceEmbedded', 'links': 'PagingLinks', 'page': 'Page'}

embedded

Gets the embedded of this AssetListResource.

Returns:The embedded of this AssetListResource. Return type:AssetListResourceEmbedded

links

Gets the links of this AssetListResource.

Returns:The links of this AssetListResource. Return type:PagingLinks

page

Gets the page of this AssetListResource.

Returns:The page of this AssetListResource. Return type:Page

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

assetmanagement.models.asset_list_resource_embedded module

Asset Management API

Service for configuring, reading and managing assets, asset ~ and aspect types. # noqa: E501

class AssetListResourceEmbedded(assets=None)

Bases: object

Attributes:

attribute_types (dict): The key is attribute name

and the value is attribute type.

attribute_map (dict): The key is attribute name

and the value is json key in definition.

assets

Gets the assets of this AssetListResourceEmbedded.

Returns:The assets of this AssetListResourceEmbedded. Return type:list[AssetResource]

attribute_map = {'assets': 'assets'}

attribute_types = {'assets': 'list[AssetResource]'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

assetmanagement.models.asset_move module

Asset Management API

Service for configuring, reading and managing assets, asset ~ and aspect types. # noqa: E501

class AssetMove(new_parent_id=None)

Bases: object

Attributes:

attribute_types (dict): The key is attribute name

and the value is attribute type.

attribute_map (dict): The key is attribute name

and the value is json key in definition.

attribute_map = {'new_parent_id': 'newParentId'}

attribute_types = {'new_parent_id': 'UniqueId'}

new_parent_id

Gets the new_parent_id of this AssetMove.

Returns:The new_parent_id of this AssetMove. Return type:UniqueId

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

assetmanagement.models.asset_resource module

Asset Management API

Service for configuring, reading and managing assets, asset ~ and aspect types. # noqa: E501

class AssetResource(name=None, external_id=None, description=None, location=None, variables=None, aspects=None, file_assignments=None, type_id=None, parent_id=None, timezone=None, twin_type='performance', tenant_id=None, sub_tenant=None, t2_tenant=None, asset_id=None, locks=None, deleted=None, etag=None, links=None)

Bases: object

Attributes:

attribute_types (dict): The key is attribute name

and the value is attribute type.

attribute_map (dict): The key is attribute name

and the value is json key in definition.

aspects

Gets the aspects of this AssetResource.

Returns:The aspects of this AssetResource. Return type:list[Aspect]

asset_id

Gets the asset_id of this AssetResource.

Returns:The asset_id of this AssetResource. Return type:UniqueId

attribute_map = {'aspects': 'aspects', 'asset_id': 'assetId', 'deleted': 'deleted', 'description': 'description', 'etag': 'etag', 'external_id': 'externalId', 'file_assignments': 'fileAssignments', 'links': '_links', 'location': 'location', 'locks': 'locks', 'name': 'name', 'parent_id': 'parentId', 'sub_tenant': 'subTenant', 't2_tenant': 't2Tenant', 'tenant_id': 'tenantId', 'timezone': 'timezone', 'twin_type': 'twinType', 'type_id': 'typeId', 'variables': 'variables'}

attribute_types = {'aspects': 'list[Aspect]', 'asset_id': 'UniqueId', 'deleted': 'datetime', 'description': 'str', 'etag': 'ETag', 'external_id': 'str', 'file_assignments': 'list[FileAssignmentResource]', 'links': 'AssetLinks', 'location': 'Location', 'locks': 'list[LockResource]', 'name': 'str', 'parent_id': 'UniqueId', 'sub_tenant': 'str', 't2_tenant': 'str', 'tenant_id': 'TenantId', 'timezone': 'Timezone', 'twin_type': 'str', 'type_id': 'AssetTypeId', 'variables': 'list[Variable]'}

deleted

Gets the deleted of this AssetResource.

Returns:The deleted of this AssetResource. Return type:datetime

description

Gets the description of this AssetResource. The description of the asset

Returns:The description of this AssetResource. Return type:str

etag

Gets the etag of this AssetResource.

Returns:The etag of this AssetResource. Return type:ETag

external_id

Gets the external_id of this AssetResource. The id given by the user

Returns:The external_id of this AssetResource. Return type:str

file_assignments

Gets the file_assignments of this AssetResource.

Returns:The file_assignments of this AssetResource. Return type:list[FileAssignmentResource]

links

Gets the links of this AssetResource.

Returns:The links of this AssetResource. Return type:AssetLinks

location

Gets the location of this AssetResource.

Returns:The location of this AssetResource. Return type:Location

locks

Gets the locks of this AssetResource.

Returns:The locks of this AssetResource. Return type:list[LockResource]

name

Gets the name of this AssetResource. Name of the asset

Returns:The name of this AssetResource. Return type:str

parent_id

Gets the parent_id of this AssetResource.

Returns:The parent_id of this AssetResource. Return type:UniqueId

sub_tenant

Gets the sub_tenant of this AssetResource. The id of the end-customer.

Returns:The sub_tenant of this AssetResource. Return type:str

t2_tenant

Gets the t2_tenant of this AssetResource. The id of the end-customer. This field is DEPRECATED please use subTenant instead.

Returns:The t2_tenant of this AssetResource. Return type:str

tenant_id

Gets the tenant_id of this AssetResource.

Returns:The tenant_id of this AssetResource. Return type:TenantId

timezone

Gets the timezone of this AssetResource.

Returns:The timezone of this AssetResource. Return type:Timezone

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

twin_type

Gets the twin_type of this AssetResource.

Returns:The twin_type of this AssetResource. Return type:str

type_id

Gets the type_id of this AssetResource.

Returns:The type_id of this AssetResource. Return type:AssetTypeId

variables

Gets the variables of this AssetResource.

Returns:The variables of this AssetResource. Return type:list[Variable]

assetmanagement.models.asset_resource_with_hierarchy_path module

Asset Management API

Service for configuring, reading and managing assets, asset ~ and aspect types. # noqa: E501

class AssetResourceWithHierarchyPath(name=None, external_id=None, description=None, location=None, variables=None, aspects=None, file_assignments=None, type_id=None, parent_id=None, timezone=None, twin_type='performance', tenant_id=None, sub_tenant=None, t2_tenant=None, asset_id=None, locks=None, deleted=None, etag=None, links=None, hierarchy_path=None)

Bases: object

Attributes:

attribute_types (dict): The key is attribute name

and the value is attribute type.

attribute_map (dict): The key is attribute name

and the value is json key in definition.

aspects

Gets the aspects of this AssetResourceWithHierarchyPath.

Returns:The aspects of this AssetResourceWithHierarchyPath. Return type:list[Aspect]

asset_id

Gets the asset_id of this AssetResourceWithHierarchyPath.

Returns:The asset_id of this AssetResourceWithHierarchyPath. Return type:UniqueId

attribute_map = {'aspects': 'aspects', 'asset_id': 'assetId', 'deleted': 'deleted', 'description': 'description', 'etag': 'etag', 'external_id': 'externalId', 'file_assignments': 'fileAssignments', 'hierarchy_path': 'hierarchyPath', 'links': '_links', 'location': 'location', 'locks': 'locks', 'name': 'name', 'parent_id': 'parentId', 'sub_tenant': 'subTenant', 't2_tenant': 't2Tenant', 'tenant_id': 'tenantId', 'timezone': 'timezone', 'twin_type': 'twinType', 'type_id': 'typeId', 'variables': 'variables'}

attribute_types = {'aspects': 'list[Aspect]', 'asset_id': 'UniqueId', 'deleted': 'datetime', 'description': 'str', 'etag': 'ETag', 'external_id': 'str', 'file_assignments': 'list[FileAssignmentResource]', 'hierarchy_path': 'list[AssetResourceWithHierarchyPathHierarchyPath]', 'links': 'AssetLinks', 'location': 'Location', 'locks': 'list[LockResource]', 'name': 'str', 'parent_id': 'UniqueId', 'sub_tenant': 'str', 't2_tenant': 'str', 'tenant_id': 'TenantId', 'timezone': 'Timezone', 'twin_type': 'str', 'type_id': 'AssetTypeId', 'variables': 'list[Variable]'}

deleted

Gets the deleted of this AssetResourceWithHierarchyPath.

Returns:The deleted of this AssetResourceWithHierarchyPath. Return type:datetime

description

Gets the description of this AssetResourceWithHierarchyPath. The description of the asset

Returns:The description of this AssetResourceWithHierarchyPath. Return type:str

etag

Gets the etag of this AssetResourceWithHierarchyPath.

Returns:The etag of this AssetResourceWithHierarchyPath. Return type:ETag

external_id

Gets the external_id of this AssetResourceWithHierarchyPath. The id given by the user

Returns:The external_id of this AssetResourceWithHierarchyPath. Return type:str

file_assignments

Gets the file_assignments of this AssetResourceWithHierarchyPath.

Returns:The file_assignments of this AssetResourceWithHierarchyPath. Return type:list[FileAssignmentResource]

hierarchy_path

Gets the hierarchy_path of this AssetResourceWithHierarchyPath.

Returns:The hierarchy_path of this AssetResourceWithHierarchyPath. Return type:list[AssetResourceWithHierarchyPathHierarchyPath]

links

Gets the links of this AssetResourceWithHierarchyPath.

Returns:The links of this AssetResourceWithHierarchyPath. Return type:AssetLinks

location

Gets the location of this AssetResourceWithHierarchyPath.

Returns:The location of this AssetResourceWithHierarchyPath. Return type:Location

locks

Gets the locks of this AssetResourceWithHierarchyPath.

Returns:The locks of this AssetResourceWithHierarchyPath. Return type:list[LockResource]

name

Gets the name of this AssetResourceWithHierarchyPath. Name of the asset

Returns:The name of this AssetResourceWithHierarchyPath. Return type:str

parent_id

Gets the parent_id of this AssetResourceWithHierarchyPath.

Returns:The parent_id of this AssetResourceWithHierarchyPath. Return type:UniqueId

sub_tenant

Gets the sub_tenant of this AssetResourceWithHierarchyPath. The id of the end-customer.

Returns:The sub_tenant of this AssetResourceWithHierarchyPath. Return type:str

t2_tenant

Gets the t2_tenant of this AssetResourceWithHierarchyPath. The id of the end-customer. This field is DEPRECATED please use subTenant instead.

Returns:The t2_tenant of this AssetResourceWithHierarchyPath. Return type:str

tenant_id

Gets the tenant_id of this AssetResourceWithHierarchyPath.

Returns:The tenant_id of this AssetResourceWithHierarchyPath. Return type:TenantId

timezone

Gets the timezone of this AssetResourceWithHierarchyPath.

Returns:The timezone of this AssetResourceWithHierarchyPath. Return type:Timezone

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

twin_type

Gets the twin_type of this AssetResourceWithHierarchyPath.

Returns:The twin_type of this AssetResourceWithHierarchyPath. Return type:str

type_id

Gets the type_id of this AssetResourceWithHierarchyPath.

Returns:The type_id of this AssetResourceWithHierarchyPath. Return type:AssetTypeId

variables

Gets the variables of this AssetResourceWithHierarchyPath.

Returns:The variables of this AssetResourceWithHierarchyPath. Return type:list[Variable]

assetmanagement.models.asset_resource_with_hierarchy_path_hierarchy_path module

Asset Management API

Service for configuring, reading and managing assets, asset ~ and aspect types. # noqa: E501

class AssetResourceWithHierarchyPathHierarchyPath(asset_id=None, name=None)

Bases: object

Attributes:

attribute_types (dict): The key is attribute name

and the value is attribute type.

attribute_map (dict): The key is attribute name

and the value is json key in definition.

asset_id

Gets the asset_id of this AssetResourceWithHierarchyPathHierarchyPath.

Returns:The asset_id of this AssetResourceWithHierarchyPathHierarchyPath. Return type:UniqueId

attribute_map = {'asset_id': 'assetId', 'name': 'name'}

attribute_types = {'asset_id': 'UniqueId', 'name': 'str'}

name

Gets the name of this AssetResourceWithHierarchyPathHierarchyPath. Name of the asset

Returns:The name of this AssetResourceWithHierarchyPathHierarchyPath. Return type:str

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

assetmanagement.models.asset_type module

Asset Management API

Service for configuring, reading and managing assets, asset ~ and aspect types. # noqa: E501

class AssetType(name=None, description=None, parent_type_id=None, instantiable=True, scope='private', aspects=None, variables=None, file_assignments=None)

Bases: object

Attributes:

attribute_types (dict): The key is attribute name

and the value is attribute type.

attribute_map (dict): The key is attribute name

and the value is json key in definition.

aspects

Gets the aspects of this AssetType. Aspects of the asset-type. Once added aspects cannot be removed.

Returns:The aspects of this AssetType. Return type:list[AssetTypeAspects]

attribute_map = {'aspects': 'aspects', 'description': 'description', 'file_assignments': 'fileAssignments', 'instantiable': 'instantiable', 'name': 'name', 'parent_type_id': 'parentTypeId', 'scope': 'scope', 'variables': 'variables'}

attribute_types = {'aspects': 'list[AssetTypeAspects]', 'description': 'str', 'file_assignments': 'list[FileAssignment]', 'instantiable': 'bool', 'name': 'str', 'parent_type_id': 'AssetTypeId', 'scope': 'str', 'variables': 'list[VariableDefinition]'}

description

Gets the description of this AssetType. description

Returns:The description of this AssetType. Return type:str

file_assignments

Gets the file_assignments of this AssetType.

Returns:The file_assignments of this AssetType. Return type:list[FileAssignment]

instantiable

Gets the instantiable of this AssetType. If instances can be created from this type. A non-instantiable type could be changed to be instantiable but not the other way around.

Returns:The instantiable of this AssetType. Return type:bool

name

Gets the name of this AssetType. The type’s name.

Returns:The name of this AssetType. Return type:str

parent_type_id

Gets the parent_type_id of this AssetType.

Returns:The parent_type_id of this AssetType. Return type:AssetTypeId

scope

Gets the scope of this AssetType. Visibility of the assettype. Setting this property to public makes it available to other tenants. Private types are only visible to the user’s own tenant. Currently only private types could be created.

Returns:The scope of this AssetType. Return type:str

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

variables

Gets the variables of this AssetType. Direct variables of the asset-type. Variable names has to be unique inside the whole type-family (ancestors and descendants). Once added variables cannot be changed or removed.

Returns:The variables of this AssetType. Return type:list[VariableDefinition]

assetmanagement.models.asset_type_aspects module

Asset Management API

Service for configuring, reading and managing assets, asset ~ and aspect types. # noqa: E501

class AssetTypeAspects(name=None, aspect_type_id=None)

Bases: object

Attributes:

attribute_types (dict): The key is attribute name

and the value is attribute type.

attribute_map (dict): The key is attribute name

and the value is json key in definition.

aspect_type_id

Gets the aspect_type_id of this AssetTypeAspects.

Returns:The aspect_type_id of this AssetTypeAspects. Return type:AspectTypeId

attribute_map = {'aspect_type_id': 'aspectTypeId', 'name': 'name'}

attribute_types = {'aspect_type_id': 'AspectTypeId', 'name': 'str'}

name

Gets the name of this AssetTypeAspects. Name of the aspect. It has to be unique inside the type-family (ancestors and descendants).Cannot be changed. Reserved words (id, name, description, tenant, etag, scope, properties, propertySets, extends, variables, aspects, parentTypeId) cannot be used as aspect names.

Returns:The name of this AssetTypeAspects. Return type:str

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

assetmanagement.models.asset_type_base module

Asset Management API

Service for configuring, reading and managing assets, asset ~ and aspect types. # noqa: E501

class AssetTypeBase(name=None, description=None, parent_type_id=None, instantiable=True, scope='private')

Bases: object

Attributes:

attribute_types (dict): The key is attribute name

and the value is attribute type.

attribute_map (dict): The key is attribute name

and the value is json key in definition.

attribute_map = {'description': 'description', 'instantiable': 'instantiable', 'name': 'name', 'parent_type_id': 'parentTypeId', 'scope': 'scope'}

attribute_types = {'description': 'str', 'instantiable': 'bool', 'name': 'str', 'parent_type_id': 'AssetTypeId', 'scope': 'str'}

description

Gets the description of this AssetTypeBase. description

Returns:The description of this AssetTypeBase. Return type:str

instantiable

Gets the instantiable of this AssetTypeBase. If instances can be created from this type. A non-instantiable type could be changed to be instantiable but not the other way around.

Returns:The instantiable of this AssetTypeBase. Return type:bool

name

Gets the name of this AssetTypeBase. The type’s name.

Returns:The name of this AssetTypeBase. Return type:str

parent_type_id

Gets the parent_type_id of this AssetTypeBase.

Returns:The parent_type_id of this AssetTypeBase. Return type:AssetTypeId

scope

Gets the scope of this AssetTypeBase. Visibility of the assettype. Setting this property to public makes it available to other tenants. Private types are only visible to the user’s own tenant. Currently only private types could be created.

Returns:The scope of this AssetTypeBase. Return type:str

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

assetmanagement.models.asset_type_id module

Asset Management API

Service for configuring, reading and managing assets, asset ~ and aspect types. # noqa: E501

class AssetTypeId

Bases: object

Attributes:

attribute_types (dict): The key is attribute name

and the value is attribute type.

attribute_map (dict): The key is attribute name

and the value is json key in definition.

attribute_map = {}

attribute_types = {}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

assetmanagement.models.asset_type_links module

Asset Management API

Service for configuring, reading and managing assets, asset ~ and aspect types. # noqa: E501

class AssetTypeLinks(_self=None, parent=None)

Bases: object

Attributes:

attribute_types (dict): The key is attribute name

and the value is attribute type.

attribute_map (dict): The key is attribute name

and the value is json key in definition.

_self

Gets the _self of this AssetTypeLinks.

Returns:The _self of this AssetTypeLinks. Return type:RelSelf

attribute_map = {'_self': 'self', 'parent': 'parent'}

attribute_types = {'_self': 'RelSelf', 'parent': 'AssetTypeLinksParent'}

parent

Gets the parent of this AssetTypeLinks.

Returns:The parent of this AssetTypeLinks. Return type:AssetTypeLinksParent

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

assetmanagement.models.asset_type_links_parent module

Asset Management API

Service for configuring, reading and managing assets, asset ~ and aspect types. # noqa: E501

class AssetTypeLinksParent(href=None)

Bases: object

Attributes:

attribute_types (dict): The key is attribute name

and the value is attribute type.

attribute_map (dict): The key is attribute name

and the value is json key in definition.

attribute_map = {'href': 'href'}

attribute_types = {'href': 'str'}

href

Gets the href of this AssetTypeLinksParent. Link to the parent asset type

Returns:The href of this AssetTypeLinksParent. Return type:str

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

assetmanagement.models.asset_type_list_resource module

Asset Management API

Service for configuring, reading and managing assets, asset ~ and aspect types. # noqa: E501

class AssetTypeListResource(embedded=None, page=None, links=None)

Bases: object

Attributes:

attribute_types (dict): The key is attribute name

and the value is attribute type.

attribute_map (dict): The key is attribute name

and the value is json key in definition.

attribute_map = {'embedded': '_embedded', 'links': '_links', 'page': 'page'}

attribute_types = {'embedded': 'AssetTypeListResourceEmbedded', 'links': 'PagingLinks', 'page': 'Page'}

embedded

Gets the embedded of this AssetTypeListResource.

Returns:The embedded of this AssetTypeListResource. Return type:AssetTypeListResourceEmbedded

links

Gets the links of this AssetTypeListResource.

Returns:The links of this AssetTypeListResource. Return type:PagingLinks

page

Gets the page of this AssetTypeListResource.

Returns:The page of this AssetTypeListResource. Return type:Page

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

assetmanagement.models.asset_type_list_resource_embedded module

Asset Management API

Service for configuring, reading and managing assets, asset ~ and aspect types. # noqa: E501

class AssetTypeListResourceEmbedded(asset_types=None)

Bases: object

Attributes:

attribute_types (dict): The key is attribute name

and the value is attribute type.

attribute_map (dict): The key is attribute name

and the value is json key in definition.

asset_types

Gets the asset_types of this AssetTypeListResourceEmbedded.

Returns:The asset_types of this AssetTypeListResourceEmbedded. Return type:list[AssetTypeResource]

attribute_map = {'asset_types': 'assetTypes'}

attribute_types = {'asset_types': 'list[AssetTypeResource]'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

assetmanagement.models.asset_type_resource module

Asset Management API

Service for configuring, reading and managing assets, asset ~ and aspect types. # noqa: E501

class AssetTypeResource(name=None, description=None, parent_type_id=None, instantiable=True, scope='private', id=None, tenant_id=None, etag=None, aspects=None, variables=None, file_assignments=None, links=None)

Bases: object

Attributes:

attribute_types (dict): The key is attribute name

and the value is attribute type.

attribute_map (dict): The key is attribute name

and the value is json key in definition.

aspects

Gets the aspects of this AssetTypeResource.

Returns:The aspects of this AssetTypeResource. Return type:list[AssetTypeResourceAspects]

attribute_map = {'aspects': 'aspects', 'description': 'description', 'etag': 'etag', 'file_assignments': 'fileAssignments', 'id': 'id', 'instantiable': 'instantiable', 'links': '_links', 'name': 'name', 'parent_type_id': 'parentTypeId', 'scope': 'scope', 'tenant_id': 'tenantId', 'variables': 'variables'}

attribute_types = {'aspects': 'list[AssetTypeResourceAspects]', 'description': 'str', 'etag': 'ETag', 'file_assignments': 'list[FileAssignmentResource]', 'id': 'AssetTypeId', 'instantiable': 'bool', 'links': 'AssetTypeLinks', 'name': 'str', 'parent_type_id': 'AssetTypeId', 'scope': 'str', 'tenant_id': 'TenantId', 'variables': 'list[VariableDefinitionResource]'}

description

Gets the description of this AssetTypeResource. description

Returns:The description of this AssetTypeResource. Return type:str

etag

Gets the etag of this AssetTypeResource.

Returns:The etag of this AssetTypeResource. Return type:ETag

file_assignments

Gets the file_assignments of this AssetTypeResource.

Returns:The file_assignments of this AssetTypeResource. Return type:list[FileAssignmentResource]

id

Gets the id of this AssetTypeResource.

Returns:The id of this AssetTypeResource. Return type:AssetTypeId

instantiable

Gets the instantiable of this AssetTypeResource. If instances can be created from this type. A non-instantiable type could be changed to be instantiable but not the other way around.

Returns:The instantiable of this AssetTypeResource. Return type:bool

links

Gets the links of this AssetTypeResource.

Returns:The links of this AssetTypeResource. Return type:AssetTypeLinks

name

Gets the name of this AssetTypeResource. The type’s name.

Returns:The name of this AssetTypeResource. Return type:str

parent_type_id

Gets the parent_type_id of this AssetTypeResource.

Returns:The parent_type_id of this AssetTypeResource. Return type:AssetTypeId

scope

Gets the scope of this AssetTypeResource. Visibility of the assettype. Setting this property to public makes it available to other tenants. Private types are only visible to the user’s own tenant. Currently only private types could be created.

Returns:The scope of this AssetTypeResource. Return type:str

tenant_id

Gets the tenant_id of this AssetTypeResource.

Returns:The tenant_id of this AssetTypeResource. Return type:TenantId

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

variables

Gets the variables of this AssetTypeResource. Direct variables of the asset-type. Variable names has to be unique inside the whole type-family (ancestors and descendants). Once added variables cannot be changed or removed.

Returns:The variables of this AssetTypeResource. Return type:list[VariableDefinitionResource]

assetmanagement.models.asset_type_resource_aspects module

Asset Management API

Service for configuring, reading and managing assets, asset ~ and aspect types. # noqa: E501

class AssetTypeResourceAspects(name=None, links=None)

Bases: object

Attributes:

attribute_types (dict): The key is attribute name

and the value is attribute type.

attribute_map (dict): The key is attribute name

and the value is json key in definition.

attribute_map = {'links': '_links', 'name': 'name'}

attribute_types = {'links': 'AssetTypeResourceLinks', 'name': 'str'}

links

Gets the links of this AssetTypeResourceAspects.

Returns:The links of this AssetTypeResourceAspects. Return type:AssetTypeResourceLinks

name

Gets the name of this AssetTypeResourceAspects. Name of the aspect type, it must be unique for the asset type.

Returns:The name of this AssetTypeResourceAspects. Return type:str

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

assetmanagement.models.asset_type_resource_links module

Asset Management API

Service for configuring, reading and managing assets, asset ~ and aspect types. # noqa: E501

class AssetTypeResourceLinks(origin=None)

Bases: object

Attributes:

attribute_types (dict): The key is attribute name

and the value is attribute type.

attribute_map (dict): The key is attribute name

and the value is json key in definition.

attribute_map = {'origin': 'origin'}

attribute_types = {'origin': 'AssetTypeResourceLinksOrigin'}

origin

Gets the origin of this AssetTypeResourceLinks.

Returns:The origin of this AssetTypeResourceLinks. Return type:AssetTypeResourceLinksOrigin

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

assetmanagement.models.asset_type_resource_links_origin module

Asset Management API

Service for configuring, reading and managing assets, asset ~ and aspect types. # noqa: E501

class AssetTypeResourceLinksOrigin(href=None)

Bases: object

Attributes:

attribute_types (dict): The key is attribute name

and the value is attribute type.

attribute_map (dict): The key is attribute name

and the value is json key in definition.

attribute_map = {'href': 'href'}

attribute_types = {'href': 'str'}

href

Gets the href of this AssetTypeResourceLinksOrigin. Link to the asset type defining the aspect. Only visible if aspect is inherited.

Returns:The href of this AssetTypeResourceLinksOrigin. Return type:str

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

assetmanagement.models.asset_update module

Asset Management API

Service for configuring, reading and managing assets, asset ~ and aspect types. # noqa: E501

class AssetUpdate(name=None, external_id=None, description=None, location=None, variables=None, aspects=None, file_assignments=None)

Bases: object

Attributes:

attribute_types (dict): The key is attribute name

and the value is attribute type.

attribute_map (dict): The key is attribute name

and the value is json key in definition.

aspects

Gets the aspects of this AssetUpdate.

Returns:The aspects of this AssetUpdate. Return type:list[Aspect]

attribute_map = {'aspects': 'aspects', 'description': 'description', 'external_id': 'externalId', 'file_assignments': 'fileAssignments', 'location': 'location', 'name': 'name', 'variables': 'variables'}

attribute_types = {'aspects': 'list[Aspect]', 'description': 'str', 'external_id': 'str', 'file_assignments': 'list[FileAssignment]', 'location': 'Location', 'name': 'str', 'variables': 'list[Variable]'}

description

Gets the description of this AssetUpdate. The description of the asset

Returns:The description of this AssetUpdate. Return type:str

external_id

Gets the external_id of this AssetUpdate. The id given by the user

Returns:The external_id of this AssetUpdate. Return type:str

file_assignments

Gets the file_assignments of this AssetUpdate.

Returns:The file_assignments of this AssetUpdate. Return type:list[FileAssignment]

location

Gets the location of this AssetUpdate.

Returns:The location of this AssetUpdate. Return type:Location

name

Gets the name of this AssetUpdate. Name of the asset

Returns:The name of this AssetUpdate. Return type:str

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

variables

Gets the variables of this AssetUpdate.

Returns:The variables of this AssetUpdate. Return type:list[Variable]

assetmanagement.models.billboard_resource module

Asset Management API

Service for configuring, reading and managing assets, asset ~ and aspect types. # noqa: E501

class BillboardResource(_self=None, aspect_types=None, asset_types=None, assets=None, files=None)

Bases: object

Attributes:

attribute_types (dict): The key is attribute name

and the value is attribute type.

attribute_map (dict): The key is attribute name

and the value is json key in definition.

_self

Gets the _self of this BillboardResource.

Returns:The _self of this BillboardResource. Return type:BillboardResourceSelf

aspect_types

Gets the aspect_types of this BillboardResource.

Returns:The aspect_types of this BillboardResource. Return type:BillboardResourceAspectTypes

asset_types

Gets the asset_types of this BillboardResource.

Returns:The asset_types of this BillboardResource. Return type:BillboardResourceAssetTypes

assets

Gets the assets of this BillboardResource.

Returns:The assets of this BillboardResource. Return type:BillboardResourceAssets

attribute_map = {'_self': 'self', 'aspect_types': 'aspectTypes', 'asset_types': 'assetTypes', 'assets': 'assets', 'files': 'files'}

attribute_types = {'_self': 'BillboardResourceSelf', 'aspect_types': 'BillboardResourceAspectTypes', 'asset_types': 'BillboardResourceAssetTypes', 'assets': 'BillboardResourceAssets', 'files': 'BillboardResourceFiles'}

files

Gets the files of this BillboardResource.

Returns:The files of this BillboardResource. Return type:BillboardResourceFiles

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

assetmanagement.models.billboard_resource_aspect_types module

Asset Management API

Service for configuring, reading and managing assets, asset ~ and aspect types. # noqa: E501

class BillboardResourceAspectTypes(href=None)

Bases: object

Attributes:

attribute_types (dict): The key is attribute name

and the value is attribute type.

attribute_map (dict): The key is attribute name

and the value is json key in definition.

attribute_map = {'href': 'href'}

attribute_types = {'href': 'str'}

href

Gets the href of this BillboardResourceAspectTypes. Link to aspect-types resource

Returns:The href of this BillboardResourceAspectTypes. Return type:str

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

assetmanagement.models.billboard_resource_asset_types module

Asset Management API

Service for configuring, reading and managing assets, asset ~ and aspect types. # noqa: E501

class BillboardResourceAssetTypes(href=None)

Bases: object

Attributes:

attribute_types (dict): The key is attribute name

and the value is attribute type.

attribute_map (dict): The key is attribute name

and the value is json key in definition.

attribute_map = {'href': 'href'}

attribute_types = {'href': 'str'}

href

Gets the href of this BillboardResourceAssetTypes. Link to asset-types resource

Returns:The href of this BillboardResourceAssetTypes. Return type:str

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

assetmanagement.models.billboard_resource_assets module

Asset Management API

Service for configuring, reading and managing assets, asset ~ and aspect types. # noqa: E501

class BillboardResourceAssets(href=None)

Bases: object

Attributes:

attribute_types (dict): The key is attribute name

and the value is attribute type.

attribute_map (dict): The key is attribute name

and the value is json key in definition.

attribute_map = {'href': 'href'}

attribute_types = {'href': 'str'}

href

Gets the href of this BillboardResourceAssets. Link to assets resource

Returns:The href of this BillboardResourceAssets. Return type:str

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

assetmanagement.models.billboard_resource_files module

Asset Management API

Service for configuring, reading and managing assets, asset ~ and aspect types. # noqa: E501

class BillboardResourceFiles(href=None)

Bases: object

Attributes:

attribute_types (dict): The key is attribute name

and the value is attribute type.

attribute_map (dict): The key is attribute name

and the value is json key in definition.

attribute_map = {'href': 'href'}

attribute_types = {'href': 'str'}

href

Gets the href of this BillboardResourceFiles. Link to files resource

Returns:The href of this BillboardResourceFiles. Return type:str

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

assetmanagement.models.billboard_resource_self module

Asset Management API

Service for configuring, reading and managing assets, asset ~ and aspect types. # noqa: E501

class BillboardResourceSelf(href=None)

Bases: object

Attributes:

attribute_types (dict): The key is attribute name

and the value is attribute type.

attribute_map (dict): The key is attribute name

and the value is json key in definition.

attribute_map = {'href': 'href'}

attribute_types = {'href': 'str'}

href

Gets the href of this BillboardResourceSelf. Link to the billboard url

Returns:The href of this BillboardResourceSelf. Return type:str

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

assetmanagement.models.delete_aspect_type_request module

Asset Management API

Service for configuring, reading and managing assets, asset ~ and aspect types. # noqa: E501

class DeleteAspectTypeRequest(if_match=None, id=None)

Bases: object

Attributes:

attribute_types (dict): The key is attribute name

and the value is attribute type.

attribute_map (dict): The key is attribute name

and the value is json key in definition.

attribute_map = {'id': 'id', 'if_match': 'If-Match'}

attribute_types = {'id': 'str', 'if_match': 'str'}

id

Gets the id of this DeleteAspectTypeRequest.

Returns:The id of this DeleteAspectTypeRequest. Return type:str

if_match

Gets the if_match of this DeleteAspectTypeRequest.

Returns:The if_match of this DeleteAspectTypeRequest. Return type:str

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

assetmanagement.models.delete_asset_confirmation_request module

Asset Management API

Service for configuring, reading and managing assets, asset ~ and aspect types. # noqa: E501

class DeleteAssetConfirmationRequest(if_match=None, id=None)

Bases: object

Attributes:

attribute_types (dict): The key is attribute name

and the value is attribute type.

attribute_map (dict): The key is attribute name

and the value is json key in definition.

attribute_map = {'id': 'id', 'if_match': 'If-Match'}

attribute_types = {'id': 'str', 'if_match': 'str'}

id

Gets the id of this DeleteAssetConfirmationRequest.

Returns:The id of this DeleteAssetConfirmationRequest. Return type:str

if_match

Gets the if_match of this DeleteAssetConfirmationRequest.

Returns:The if_match of this DeleteAssetConfirmationRequest. Return type:str

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

assetmanagement.models.delete_asset_file_assigment_request module

Asset Management API

Service for configuring, reading and managing assets, asset ~ and aspect types. # noqa: E501

class DeleteAssetFileAssigmentRequest(if_match=None, id=None, key=None)

Bases: object

Attributes:

attribute_types (dict): The key is attribute name

and the value is attribute type.

attribute_map (dict): The key is attribute name

and the value is json key in definition.

attribute_map = {'id': 'id', 'if_match': 'If-Match', 'key': 'key'}

attribute_types = {'id': 'str', 'if_match': 'str', 'key': 'str'}

id

Gets the id of this DeleteAssetFileAssigmentRequest.

Returns:The id of this DeleteAssetFileAssigmentRequest. Return type:str

if_match

Gets the if_match of this DeleteAssetFileAssigmentRequest.

Returns:The if_match of this DeleteAssetFileAssigmentRequest. Return type:str

key

Gets the key of this DeleteAssetFileAssigmentRequest.

Returns:The key of this DeleteAssetFileAssigmentRequest. Return type:str

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

assetmanagement.models.delete_asset_location_request module

Asset Management API

Service for configuring, reading and managing assets, asset ~ and aspect types. # noqa: E501

class DeleteAssetLocationRequest(if_match=None, id=None)

Bases: object

Attributes:

attribute_types (dict): The key is attribute name

and the value is attribute type.

attribute_map (dict): The key is attribute name

and the value is json key in definition.

attribute_map = {'id': 'id', 'if_match': 'If-Match'}

attribute_types = {'id': 'str', 'if_match': 'str'}

id

Gets the id of this DeleteAssetLocationRequest.

Returns:The id of this DeleteAssetLocationRequest. Return type:str

if_match

Gets the if_match of this DeleteAssetLocationRequest.

Returns:The if_match of this DeleteAssetLocationRequest. Return type:str

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

assetmanagement.models.delete_asset_request module

Asset Management API

Service for configuring, reading and managing assets, asset ~ and aspect types. # noqa: E501

class DeleteAssetRequest(if_match=None, id=None)

Bases: object

Attributes:

attribute_types (dict): The key is attribute name

and the value is attribute type.

attribute_map (dict): The key is attribute name

and the value is json key in definition.

attribute_map = {'id': 'id', 'if_match': 'If-Match'}

attribute_types = {'id': 'str', 'if_match': 'str'}

id

Gets the id of this DeleteAssetRequest.

Returns:The id of this DeleteAssetRequest. Return type:str

if_match

Gets the if_match of this DeleteAssetRequest.

Returns:The if_match of this DeleteAssetRequest. Return type:str

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

assetmanagement.models.delete_asset_type_file_assignment_request module

Asset Management API

Service for configuring, reading and managing assets, asset ~ and aspect types. # noqa: E501

class DeleteAssetTypeFileAssignmentRequest(if_match=None, id=None, key=None)

Bases: object

Attributes:

attribute_types (dict): The key is attribute name

and the value is attribute type.

attribute_map (dict): The key is attribute name

and the value is json key in definition.

attribute_map = {'id': 'id', 'if_match': 'If-Match', 'key': 'key'}

attribute_types = {'id': 'str', 'if_match': 'str', 'key': 'str'}

id

Gets the id of this DeleteAssetTypeFileAssignmentRequest.

Returns:The id of this DeleteAssetTypeFileAssignmentRequest. Return type:str

if_match

Gets the if_match of this DeleteAssetTypeFileAssignmentRequest.

Returns:The if_match of this DeleteAssetTypeFileAssignmentRequest. Return type:str

key

Gets the key of this DeleteAssetTypeFileAssignmentRequest.

Returns:The key of this DeleteAssetTypeFileAssignmentRequest. Return type:str

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

assetmanagement.models.delete_asset_type_request module

Asset Management API

Service for configuring, reading and managing assets, asset ~ and aspect types. # noqa: E501

class DeleteAssetTypeRequest(if_match=None, id=None)

Bases: object

Attributes:

attribute_types (dict): The key is attribute name

and the value is attribute type.

attribute_map (dict): The key is attribute name

and the value is json key in definition.

attribute_map = {'id': 'id', 'if_match': 'If-Match'}

attribute_types = {'id': 'str', 'if_match': 'str'}

id

Gets the id of this DeleteAssetTypeRequest.

Returns:The id of this DeleteAssetTypeRequest. Return type:str

if_match

Gets the if_match of this DeleteAssetTypeRequest.

Returns:The if_match of this DeleteAssetTypeRequest. Return type:str

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

assetmanagement.models.delete_file_request module

Asset Management API

Service for configuring, reading and managing assets, asset ~ and aspect types. # noqa: E501

class DeleteFileRequest(if_match=None, file_id=None)

Bases: object

Attributes:

attribute_types (dict): The key is attribute name

and the value is attribute type.

attribute_map (dict): The key is attribute name

and the value is json key in definition.

attribute_map = {'file_id': 'fileId', 'if_match': 'If-Match'}

attribute_types = {'file_id': 'str', 'if_match': 'str'}

file_id

Gets the file_id of this DeleteFileRequest.

Returns:The file_id of this DeleteFileRequest. Return type:str

if_match

Gets the if_match of this DeleteFileRequest.

Returns:The if_match of this DeleteFileRequest. Return type:str

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

assetmanagement.models.download_file_request module

Asset Management API

Service for configuring, reading and managing assets, asset ~ and aspect types. # noqa: E501

class DownloadFileRequest(file_id=None)

Bases: object

Attributes:

attribute_types (dict): The key is attribute name

and the value is attribute type.

attribute_map (dict): The key is attribute name

and the value is json key in definition.

attribute_map = {'file_id': 'fileId'}

attribute_types = {'file_id': 'str'}

file_id

Gets the file_id of this DownloadFileRequest.

Returns:The file_id of this DownloadFileRequest. Return type:str

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

assetmanagement.models.e_tag module

Asset Management API

Service for configuring, reading and managing assets, asset ~ and aspect types. # noqa: E501

class ETag

Bases: object

Attributes:

attribute_types (dict): The key is attribute name

and the value is attribute type.

attribute_map (dict): The key is attribute name

and the value is json key in definition.

attribute_map = {}

attribute_types = {}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

assetmanagement.models.errors module

Asset Management API

Service for configuring, reading and managing assets, asset ~ and aspect types. # noqa: E501

class Errors

Bases: list

Attributes:

attribute_types (dict): The key is attribute name

and the value is attribute type.

attribute_map (dict): The key is attribute name

and the value is json key in definition.

append(object) → None -- append object to end

attribute_map = {}

attribute_types = {}

clear() → None -- remove all items from L

copy() → list -- a shallow copy of L

count(value) → integer -- return number of occurrences of value

extend(iterable) → None -- extend list by appending elements from the iterable

index(value[, start[, stop]]) → integer -- return first index of value.

Raises ValueError if the value is not present.

insert()

L.insert(index, object) – insert object before index

pop([index]) → item -- remove and return item at index (default last).

Raises IndexError if list is empty or index is out of range.

remove(value) → None -- remove first occurrence of value.

Raises ValueError if the value is not present.

reverse()

L.reverse() – reverse IN PLACE

sort(key=None, reverse=False) → None -- stable sort *IN PLACE*

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

assetmanagement.models.errors_inner module

Asset Management API

Service for configuring, reading and managing assets, asset ~ and aspect types. # noqa: E501

class ErrorsInner(errorcode=None, logref=None, message=None)

Bases: object

Attributes:

attribute_types (dict): The key is attribute name

and the value is attribute type.

attribute_map (dict): The key is attribute name

and the value is json key in definition.

attribute_map = {'errorcode': 'errorcode', 'logref': 'logref', 'message': 'message'}

attribute_types = {'errorcode': 'float', 'logref': 'str', 'message': 'str'}

errorcode

Gets the errorcode of this ErrorsInner.

Returns:The errorcode of this ErrorsInner. Return type:float

logref

Gets the logref of this ErrorsInner.

Returns:The logref of this ErrorsInner. Return type:str

message

Gets the message of this ErrorsInner.

Returns:The message of this ErrorsInner. Return type:str

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

assetmanagement.models.field_type_enum module

class FieldTypeEnum(value=None)

Bases: enum.Enum

An enumeration.

ASSET_ID = 'assetId'

DELETED = 'deleted'

EXTERNAL_ID = 'externalId'

NAME = 'name'

PARENT_ID = 'parentId'

PARENT_TYPE_ID = 'parentTypeId'

SUBTENANT = 'subTenant'

TENANT_ID = 'tenantId'

TYPE_ID = 'typeId'

assetmanagement.models.file_assignment module

Asset Management API

Service for configuring, reading and managing assets, asset ~ and aspect types. # noqa: E501

class FileAssignment(key=None, file_id=None)

Bases: object

Attributes:

attribute_types (dict): The key is attribute name

and the value is attribute type.

attribute_map (dict): The key is attribute name

and the value is json key in definition.

attribute_map = {'file_id': 'fileId', 'key': 'key'}

attribute_types = {'file_id': 'str', 'key': 'str'}

file_id

Gets the file_id of this FileAssignment. The id of the file to be assigned

Returns:The file_id of this FileAssignment. Return type:str

key

Gets the key of this FileAssignment. Keyword for the file to be assigned to an asset.

Returns:The key of this FileAssignment. Return type:str

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

assetmanagement.models.file_assignment_links module

Asset Management API

Service for configuring, reading and managing assets, asset ~ and aspect types. # noqa: E501

class FileAssignmentLinks(download=None, metadata=None, origin=None)

Bases: object

Attributes:

attribute_types (dict): The key is attribute name

and the value is attribute type.

attribute_map (dict): The key is attribute name

and the value is json key in definition.

attribute_map = {'download': 'download', 'metadata': 'metadata', 'origin': 'origin'}

attribute_types = {'download': 'FileAssignmentLinksDownload', 'metadata': 'FileAssignmentLinksMetadata', 'origin': 'FileAssignmentLinksOrigin'}

download

Gets the download of this FileAssignmentLinks.

Returns:The download of this FileAssignmentLinks. Return type:FileAssignmentLinksDownload

metadata

Gets the metadata of this FileAssignmentLinks.

Returns:The metadata of this FileAssignmentLinks. Return type:FileAssignmentLinksMetadata

origin

Gets the origin of this FileAssignmentLinks.

Returns:The origin of this FileAssignmentLinks. Return type:FileAssignmentLinksOrigin

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

assetmanagement.models.file_assignment_links_download module

Asset Management API

Service for configuring, reading and managing assets, asset ~ and aspect types. # noqa: E501

class FileAssignmentLinksDownload(href=None)

Bases: object

Attributes:

attribute_types (dict): The key is attribute name

and the value is attribute type.

attribute_map (dict): The key is attribute name

and the value is json key in definition.

attribute_map = {'href': 'href'}

attribute_types = {'href': 'str'}

href

Gets the href of this FileAssignmentLinksDownload. Link to download the file

Returns:The href of this FileAssignmentLinksDownload. Return type:str

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

assetmanagement.models.file_assignment_links_metadata module

Asset Management API

Service for configuring, reading and managing assets, asset ~ and aspect types. # noqa: E501

class FileAssignmentLinksMetadata(href=None)

Bases: object

Attributes:

attribute_types (dict): The key is attribute name

and the value is attribute type.

attribute_map (dict): The key is attribute name

and the value is json key in definition.

attribute_map = {'href': 'href'}

attribute_types = {'href': 'str'}

href

Gets the href of this FileAssignmentLinksMetadata. Link to get metadata of the file

Returns:The href of this FileAssignmentLinksMetadata. Return type:str

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

assetmanagement.models.file_assignment_links_origin module

Asset Management API

Service for configuring, reading and managing assets, asset ~ and aspect types. # noqa: E501

class FileAssignmentLinksOrigin(href=None)

Bases: object

Attributes:

attribute_types (dict): The key is attribute name

and the value is attribute type.

attribute_map (dict): The key is attribute name

and the value is json key in definition.

attribute_map = {'href': 'href'}

attribute_types = {'href': 'str'}

href

Gets the href of this FileAssignmentLinksOrigin. Link to access the file assignment. Only visible if assignment is inherited

Returns:The href of this FileAssignmentLinksOrigin. Return type:str

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

assetmanagement.models.file_assignment_resource module

Asset Management API

Service for configuring, reading and managing assets, asset ~ and aspect types. # noqa: E501

class FileAssignmentResource(key=None, file_id=None, links=None)

Bases: object

Attributes:

attribute_types (dict): The key is attribute name

and the value is attribute type.

attribute_map (dict): The key is attribute name

and the value is json key in definition.

attribute_map = {'file_id': 'fileId', 'key': 'key', 'links': '_links'}

attribute_types = {'file_id': 'str', 'key': 'str', 'links': 'FileAssignmentLinks'}

file_id

Gets the file_id of this FileAssignmentResource. The id of the file to be assigned

Returns:The file_id of this FileAssignmentResource. Return type:str

key

Gets the key of this FileAssignmentResource. Keyword for the file to be assigned to an asset.

Returns:The key of this FileAssignmentResource. Return type:str

links

Gets the links of this FileAssignmentResource.

Returns:The links of this FileAssignmentResource. Return type:FileAssignmentLinks

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

assetmanagement.models.file_metadata_list_resource module

Asset Management API

Service for configuring, reading and managing assets, asset ~ and aspect types. # noqa: E501

class FileMetadataListResource(embedded=None, page=None, links=None)

Bases: object

Attributes:

attribute_types (dict): The key is attribute name

and the value is attribute type.

attribute_map (dict): The key is attribute name

and the value is json key in definition.

attribute_map = {'embedded': '_embedded', 'links': '_links', 'page': 'page'}

attribute_types = {'embedded': 'FileMetadataListResourceEmbedded', 'links': 'PagingLinks', 'page': 'Page'}

embedded

Gets the embedded of this FileMetadataListResource.

Returns:The embedded of this FileMetadataListResource. Return type:FileMetadataListResourceEmbedded

links

Gets the links of this FileMetadataListResource.

Returns:The links of this FileMetadataListResource. Return type:PagingLinks

page

Gets the page of this FileMetadataListResource.

Returns:The page of this FileMetadataListResource. Return type:Page

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

assetmanagement.models.file_metadata_list_resource_embedded module

Asset Management API

Service for configuring, reading and managing assets, asset ~ and aspect types. # noqa: E501

class FileMetadataListResourceEmbedded(files=None)

Bases: object

Attributes:

attribute_types (dict): The key is attribute name

and the value is attribute type.

attribute_map (dict): The key is attribute name

and the value is json key in definition.

attribute_map = {'files': 'files'}

attribute_types = {'files': 'list[FileMetadataResource]'}

files

Gets the files of this FileMetadataListResourceEmbedded.

Returns:The files of this FileMetadataListResourceEmbedded. Return type:list[FileMetadataResource]

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

assetmanagement.models.file_metadata_resource module

Asset Management API

Service for configuring, reading and managing assets, asset ~ and aspect types. # noqa: E501

class FileMetadataResource(id=None, name=None, original_file_name=None, description=None, tenant_id=None, sub_tenant=None, uploaded=None, last_modified=None, is_assigned=None, scope='PRIVATE', etag=None, links=None)

Bases: object

Attributes:

attribute_types (dict): The key is attribute name

and the value is attribute type.

attribute_map (dict): The key is attribute name

and the value is json key in definition.

attribute_map = {'description': 'description', 'etag': 'etag', 'id': 'id', 'is_assigned': 'isAssigned', 'last_modified': 'lastModified', 'links': '_links', 'name': 'name', 'original_file_name': 'originalFileName', 'scope': 'scope', 'sub_tenant': 'subTenant', 'tenant_id': 'tenantId', 'uploaded': 'uploaded'}

attribute_types = {'description': 'str', 'etag': 'ETag', 'id': 'UniqueId', 'is_assigned': 'bool', 'last_modified': 'datetime', 'links': 'FileMetadataResourceLinks', 'name': 'str', 'original_file_name': 'str', 'scope': 'str', 'sub_tenant': 'str', 'tenant_id': 'TenantId', 'uploaded': 'datetime'}

description

Gets the description of this FileMetadataResource. File description

Returns:The description of this FileMetadataResource. Return type:str

etag

Gets the etag of this FileMetadataResource.

Returns:The etag of this FileMetadataResource. Return type:ETag

id

Gets the id of this FileMetadataResource.

Returns:The id of this FileMetadataResource. Return type:UniqueId

is_assigned

Gets the is_assigned of this FileMetadataResource. Is the file used in any file assignment

Returns:The is_assigned of this FileMetadataResource. Return type:bool

last_modified

Gets the last_modified of this FileMetadataResource. The time of the latest modification of the file

Returns:The last_modified of this FileMetadataResource. Return type:datetime

links

Gets the links of this FileMetadataResource.

Returns:The links of this FileMetadataResource. Return type:FileMetadataResourceLinks

name

Gets the name of this FileMetadataResource. File name given by the user

Returns:The name of this FileMetadataResource. Return type:str

original_file_name

Gets the original_file_name of this FileMetadataResource. Original filename of the file

Returns:The original_file_name of this FileMetadataResource. Return type:str

scope

Gets the scope of this FileMetadataResource. The visibility of the file. PRIVATE hides files between subTenants and the t1Tenant’s files from the subTenants. PUBLIC is visible for every user of the tenant.

Returns:The scope of this FileMetadataResource. Return type:str

sub_tenant

Gets the sub_tenant of this FileMetadataResource. The id of the end-customer

Returns:The sub_tenant of this FileMetadataResource. Return type:str

tenant_id

Gets the tenant_id of this FileMetadataResource.

Returns:The tenant_id of this FileMetadataResource. Return type:TenantId

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

uploaded

Gets the uploaded of this FileMetadataResource. The time of the file upload

Returns:The uploaded of this FileMetadataResource. Return type:datetime

assetmanagement.models.file_metadata_resource_links module

Asset Management API

Service for configuring, reading and managing assets, asset ~ and aspect types. # noqa: E501

class FileMetadataResourceLinks(_self=None, download=None)

Bases: object

Attributes:

attribute_types (dict): The key is attribute name

and the value is attribute type.

attribute_map (dict): The key is attribute name

and the value is json key in definition.

_self

Gets the _self of this FileMetadataResourceLinks.

Returns:The _self of this FileMetadataResourceLinks. Return type:RelSelf

attribute_map = {'_self': 'self', 'download': 'download'}

attribute_types = {'_self': 'RelSelf', 'download': 'LinkForDownloadingTheFile'}

download

Gets the download of this FileMetadataResourceLinks.

Returns:The download of this FileMetadataResourceLinks. Return type:LinkForDownloadingTheFile

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

assetmanagement.models.get_aspect_type_request module

Asset Management API

Service for configuring, reading and managing assets, asset ~ and aspect types. # noqa: E501

class GetAspectTypeRequest(if_none_match=None, id=None)

Bases: object

Attributes:

attribute_types (dict): The key is attribute name

and the value is attribute type.

attribute_map (dict): The key is attribute name

and the value is json key in definition.

attribute_map = {'id': 'id', 'if_none_match': 'If-None-Match'}

attribute_types = {'id': 'str', 'if_none_match': 'str'}

id

Gets the id of this GetAspectTypeRequest.

Returns:The id of this GetAspectTypeRequest. Return type:str

if_none_match

Gets the if_none_match of this GetAspectTypeRequest.

Returns:The if_none_match of this GetAspectTypeRequest. Return type:str

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

assetmanagement.models.get_asset_request module

Asset Management API

Service for configuring, reading and managing assets, asset ~ and aspect types. # noqa: E501

class GetAssetRequest(if_none_match=None, id=None)

Bases: object

Attributes:

attribute_types (dict): The key is attribute name

and the value is attribute type.

attribute_map (dict): The key is attribute name

and the value is json key in definition.

attribute_map = {'id': 'id', 'if_none_match': 'If-None-Match'}

attribute_types = {'id': 'str', 'if_none_match': 'str'}

id

Gets the id of this GetAssetRequest.

Returns:The id of this GetAssetRequest. Return type:str

if_none_match

Gets the if_none_match of this GetAssetRequest.

Returns:The if_none_match of this GetAssetRequest. Return type:str

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

assetmanagement.models.get_asset_type_request module

Asset Management API

Service for configuring, reading and managing assets, asset ~ and aspect types. # noqa: E501

class GetAssetTypeRequest(if_none_match=None, exploded=None, id=None)

Bases: object

Attributes:

attribute_types (dict): The key is attribute name

and the value is attribute type.

attribute_map (dict): The key is attribute name

and the value is json key in definition.

attribute_map = {'exploded': 'exploded', 'id': 'id', 'if_none_match': 'If-None-Match'}

attribute_types = {'exploded': 'bool', 'id': 'str', 'if_none_match': 'str'}

exploded

Gets the exploded of this GetAssetTypeRequest.

Returns:The exploded of this GetAssetTypeRequest. Return type:bool

id

Gets the id of this GetAssetTypeRequest.

Returns:The id of this GetAssetTypeRequest. Return type:str

if_none_match

Gets the if_none_match of this GetAssetTypeRequest.

Returns:The if_none_match of this GetAssetTypeRequest. Return type:str

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

assetmanagement.models.get_billboard_request module

Asset Management API

Service for configuring, reading and managing assets, asset ~ and aspect types. # noqa: E501

class GetBillboardRequest

Bases: object

Attributes:

attribute_types (dict): The key is attribute name

and the value is attribute type.

attribute_map (dict): The key is attribute name

and the value is json key in definition.

attribute_map = {}

attribute_types = {}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

assetmanagement.models.get_file_request module

Asset Management API

Service for configuring, reading and managing assets, asset ~ and aspect types. # noqa: E501

class GetFileRequest(if_none_match=None, file_id=None)

Bases: object

Attributes:

attribute_types (dict): The key is attribute name

and the value is attribute type.

attribute_map (dict): The key is attribute name

and the value is json key in definition.

attribute_map = {'file_id': 'fileId', 'if_none_match': 'If-None-Match'}

attribute_types = {'file_id': 'str', 'if_none_match': 'str'}

file_id

Gets the file_id of this GetFileRequest.

Returns:The file_id of this GetFileRequest. Return type:str

if_none_match

Gets the if_none_match of this GetFileRequest.

Returns:The if_none_match of this GetFileRequest. Return type:str

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

assetmanagement.models.get_root_asset_request module

Asset Management API

Service for configuring, reading and managing assets, asset ~ and aspect types. # noqa: E501

class GetRootAssetRequest(if_none_match=None)

Bases: object

Attributes:

attribute_types (dict): The key is attribute name

and the value is attribute type.

attribute_map (dict): The key is attribute name

and the value is json key in definition.

attribute_map = {'if_none_match': 'If-None-Match'}

attribute_types = {'if_none_match': 'str'}

if_none_match

Gets the if_none_match of this GetRootAssetRequest.

Returns:The if_none_match of this GetRootAssetRequest. Return type:str

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

assetmanagement.models.keyed_file_assignment module

Asset Management API

Service for configuring, reading and managing assets, asset ~ and aspect types. # noqa: E501

class KeyedFileAssignment(file_id=None)

Bases: object

Attributes:

attribute_types (dict): The key is attribute name

and the value is attribute type.

attribute_map (dict): The key is attribute name

and the value is json key in definition.

attribute_map = {'file_id': 'fileId'}

attribute_types = {'file_id': 'str'}

file_id

Gets the file_id of this KeyedFileAssignment. The id of the file to be assigned

Returns:The file_id of this KeyedFileAssignment. Return type:str

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

assetmanagement.models.link_for_downloading_the_file module

Asset Management API

Service for configuring, reading and managing assets, asset ~ and aspect types. # noqa: E501

class LinkForDownloadingTheFile(href=None)

Bases: object

Attributes:

attribute_types (dict): The key is attribute name

and the value is attribute type.

attribute_map (dict): The key is attribute name

and the value is json key in definition.

attribute_map = {'href': 'href'}

attribute_types = {'href': 'str'}

href

Gets the href of this LinkForDownloadingTheFile.

Returns:The href of this LinkForDownloadingTheFile. Return type:str

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

assetmanagement.models.list_aspect_types_request module

Asset Management API

Service for configuring, reading and managing assets, asset ~ and aspect types. # noqa: E501

class ListAspectTypesRequest(filter=None, if_none_match=None, size=None, page=None, sort=None)

Bases: object

Attributes:

attribute_types (dict): The key is attribute name

and the value is attribute type.

attribute_map (dict): The key is attribute name

and the value is json key in definition.

attribute_map = {'filter': 'filter', 'if_none_match': 'If-None-Match', 'page': 'page', 'size': 'size', 'sort': 'sort'}

attribute_types = {'filter': 'str', 'if_none_match': 'str', 'page': 'int', 'size': 'int', 'sort': 'str'}

filter

Gets the filter of this ListAspectTypesRequest.

Returns:The filter of this ListAspectTypesRequest. Return type:str

if_none_match

Gets the if_none_match of this ListAspectTypesRequest.

Returns:The if_none_match of this ListAspectTypesRequest. Return type:str

page

Gets the page of this ListAspectTypesRequest.

Returns:The page of this ListAspectTypesRequest. Return type:int

size

Gets the size of this ListAspectTypesRequest.

Returns:The size of this ListAspectTypesRequest. Return type:int

sort

Gets the sort of this ListAspectTypesRequest.

Returns:The sort of this ListAspectTypesRequest. Return type:str

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

assetmanagement.models.list_asset_aspects_request module

Asset Management API

Service for configuring, reading and managing assets, asset ~ and aspect types. # noqa: E501

class ListAssetAspectsRequest(filter=None, if_none_match=None, size=None, id=None, page=None, sort=None)

Bases: object

Attributes:

attribute_types (dict): The key is attribute name

and the value is attribute type.

attribute_map (dict): The key is attribute name

and the value is json key in definition.

attribute_map = {'filter': 'filter', 'id': 'id', 'if_none_match': 'If-None-Match', 'page': 'page', 'size': 'size', 'sort': 'sort'}

attribute_types = {'filter': 'str', 'id': 'str', 'if_none_match': 'str', 'page': 'int', 'size': 'int', 'sort': 'str'}

filter

Gets the filter of this ListAssetAspectsRequest.

Returns:The filter of this ListAssetAspectsRequest. Return type:str

id

Gets the id of this ListAssetAspectsRequest.

Returns:The id of this ListAssetAspectsRequest. Return type:str

if_none_match

Gets the if_none_match of this ListAssetAspectsRequest.

Returns:The if_none_match of this ListAssetAspectsRequest. Return type:str

page

Gets the page of this ListAssetAspectsRequest.

Returns:The page of this ListAssetAspectsRequest. Return type:int

size

Gets the size of this ListAssetAspectsRequest.

Returns:The size of this ListAssetAspectsRequest. Return type:int

sort

Gets the sort of this ListAssetAspectsRequest.

Returns:The sort of this ListAssetAspectsRequest. Return type:str

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

assetmanagement.models.list_asset_types_request module

Asset Management API

Service for configuring, reading and managing assets, asset ~ and aspect types. # noqa: E501

class ListAssetTypesRequest(filter=None, if_none_match=None, size=None, exploded=None, page=None, sort=None)

Bases: object

Attributes:

attribute_types (dict): The key is attribute name

and the value is attribute type.

attribute_map (dict): The key is attribute name

and the value is json key in definition.

attribute_map = {'exploded': 'exploded', 'filter': 'filter', 'if_none_match': 'If-None-Match', 'page': 'page', 'size': 'size', 'sort': 'sort'}

attribute_types = {'exploded': 'bool', 'filter': 'str', 'if_none_match': 'str', 'page': 'int', 'size': 'int', 'sort': 'str'}

exploded

Gets the exploded of this ListAssetTypesRequest.

Returns:The exploded of this ListAssetTypesRequest. Return type:bool

filter

Gets the filter of this ListAssetTypesRequest.

Returns:The filter of this ListAssetTypesRequest. Return type:str

if_none_match

Gets the if_none_match of this ListAssetTypesRequest.

Returns:The if_none_match of this ListAssetTypesRequest. Return type:str

page

Gets the page of this ListAssetTypesRequest.

Returns:The page of this ListAssetTypesRequest. Return type:int

size

Gets the size of this ListAssetTypesRequest.

Returns:The size of this ListAssetTypesRequest. Return type:int

sort

Gets the sort of this ListAssetTypesRequest.

Returns:The sort of this ListAssetTypesRequest. Return type:str

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

assetmanagement.models.list_asset_variables_request module

Asset Management API

Service for configuring, reading and managing assets, asset ~ and aspect types. # noqa: E501

class ListAssetVariablesRequest(filter=None, if_none_match=None, size=None, id=None, page=None, sort=None)

Bases: object

Attributes:

attribute_types (dict): The key is attribute name

and the value is attribute type.

attribute_map (dict): The key is attribute name

and the value is json key in definition.

attribute_map = {'filter': 'filter', 'id': 'id', 'if_none_match': 'If-None-Match', 'page': 'page', 'size': 'size', 'sort': 'sort'}

attribute_types = {'filter': 'str', 'id': 'str', 'if_none_match': 'str', 'page': 'int', 'size': 'int', 'sort': 'str'}

filter

Gets the filter of this ListAssetVariablesRequest.

Returns:The filter of this ListAssetVariablesRequest. Return type:str

id

Gets the id of this ListAssetVariablesRequest.

Returns:The id of this ListAssetVariablesRequest. Return type:str

if_none_match

Gets the if_none_match of this ListAssetVariablesRequest.

Returns:The if_none_match of this ListAssetVariablesRequest. Return type:str

page

Gets the page of this ListAssetVariablesRequest.

Returns:The page of this ListAssetVariablesRequest. Return type:int

size

Gets the size of this ListAssetVariablesRequest.

Returns:The size of this ListAssetVariablesRequest. Return type:int

sort

Gets the sort of this ListAssetVariablesRequest.

Returns:The sort of this ListAssetVariablesRequest. Return type:str

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

assetmanagement.models.list_assets_request module

Asset Management API

Service for configuring, reading and managing assets, asset ~ and aspect types. # noqa: E501

class ListAssetsRequest(filter=None, if_none_match=None, size=None, page=None, sort=None)

Bases: object

Attributes:

attribute_types (dict): The key is attribute name

and the value is attribute type.

attribute_map (dict): The key is attribute name

and the value is json key in definition.

attribute_map = {'filter': 'filter', 'if_none_match': 'If-None-Match', 'page': 'page', 'size': 'size', 'sort': 'sort'}

attribute_types = {'filter': 'str', 'if_none_match': 'str', 'page': 'int', 'size': 'int', 'sort': 'str'}

filter

Gets the filter of this ListAssetsRequest.

Returns:The filter of this ListAssetsRequest. Return type:str

if_none_match

Gets the if_none_match of this ListAssetsRequest.

Returns:The if_none_match of this ListAssetsRequest. Return type:str

page

Gets the page of this ListAssetsRequest.

Returns:The page of this ListAssetsRequest. Return type:int

size

Gets the size of this ListAssetsRequest.

Returns:The size of this ListAssetsRequest. Return type:int

sort

Gets the sort of this ListAssetsRequest.

Returns:The sort of this ListAssetsRequest. Return type:str

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

assetmanagement.models.list_files_request module

Asset Management API

Service for configuring, reading and managing assets, asset ~ and aspect types. # noqa: E501

class ListFilesRequest(filter=None, if_none_match=None, size=None, page=None, sort=None)

Bases: object

Attributes:

attribute_types (dict): The key is attribute name

and the value is attribute type.

attribute_map (dict): The key is attribute name

and the value is json key in definition.

attribute_map = {'filter': 'filter', 'if_none_match': 'If-None-Match', 'page': 'page', 'size': 'size', 'sort': 'sort'}

attribute_types = {'filter': 'str', 'if_none_match': 'str', 'page': 'int', 'size': 'int', 'sort': 'str'}

filter

Gets the filter of this ListFilesRequest.

Returns:The filter of this ListFilesRequest. Return type:str

if_none_match

Gets the if_none_match of this ListFilesRequest.

Returns:The if_none_match of this ListFilesRequest. Return type:str

page

Gets the page of this ListFilesRequest.

Returns:The page of this ListFilesRequest. Return type:int

size

Gets the size of this ListFilesRequest.

Returns:The size of this ListFilesRequest. Return type:int

sort

Gets the sort of this ListFilesRequest.

Returns:The sort of this ListFilesRequest. Return type:str

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

assetmanagement.models.location module

Asset Management API

Service for configuring, reading and managing assets, asset ~ and aspect types. # noqa: E501

class Location(country=None, region=None, locality=None, street_address=None, postal_code=None, longitude=None, latitude=None)

Bases: object

Attributes:

attribute_types (dict): The key is attribute name

and the value is attribute type.

attribute_map (dict): The key is attribute name

and the value is json key in definition.

attribute_map = {'country': 'country', 'latitude': 'latitude', 'locality': 'locality', 'longitude': 'longitude', 'postal_code': 'postalCode', 'region': 'region', 'street_address': 'streetAddress'}

attribute_types = {'country': 'str', 'latitude': 'float', 'locality': 'str', 'longitude': 'float', 'postal_code': 'str', 'region': 'str', 'street_address': 'str'}

country

Gets the country of this Location.

Returns:The country of this Location. Return type:str

latitude

Gets the latitude of this Location. The latitude part of the geographic coordinates

Returns:The latitude of this Location. Return type:float

locality

Gets the locality of this Location.

Returns:The locality of this Location. Return type:str

longitude

Gets the longitude of this Location. The longitude part of the geographic coordinates

Returns:The longitude of this Location. Return type:float

postal_code

Gets the postal_code of this Location.

Returns:The postal_code of this Location. Return type:str

region

Gets the region of this Location. County or other region code or name

Returns:The region of this Location. Return type:str

street_address

Gets the street_address of this Location.

Returns:The street_address of this Location. Return type:str

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

assetmanagement.models.lock_resource module

Asset Management API

Service for configuring, reading and managing assets, asset ~ and aspect types. # noqa: E501

class LockResource(id=None, service=None, reason=None, reason_code=None, links=None)

Bases: object

Attributes:

attribute_types (dict): The key is attribute name

and the value is attribute type.

attribute_map (dict): The key is attribute name

and the value is json key in definition.

attribute_map = {'id': 'id', 'links': '_links', 'reason': 'reason', 'reason_code': 'reasonCode', 'service': 'service'}

attribute_types = {'id': 'UniqueId', 'links': 'LockResourceLinks', 'reason': 'str', 'reason_code': 'str', 'service': 'str'}

id

Gets the id of this LockResource.

Returns:The id of this LockResource. Return type:UniqueId

links

Gets the links of this LockResource.

Returns:The links of this LockResource. Return type:LockResourceLinks

reason

Gets the reason of this LockResource. Reason of lock

Returns:The reason of this LockResource. Return type:str

reason_code

Gets the reason_code of this LockResource. Code of the reason

Returns:The reason_code of this LockResource. Return type:str

service

Gets the service of this LockResource. Service creating the lock

Returns:The service of this LockResource. Return type:str

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

assetmanagement.models.lock_resource_links module

Asset Management API

Service for configuring, reading and managing assets, asset ~ and aspect types. # noqa: E501

class LockResourceLinks(_self=None)

Bases: object

Attributes:

attribute_types (dict): The key is attribute name

and the value is attribute type.

attribute_map (dict): The key is attribute name

and the value is json key in definition.

_self

Gets the _self of this LockResourceLinks.

Returns:The _self of this LockResourceLinks. Return type:RelSelf

attribute_map = {'_self': 'self'}

attribute_types = {'_self': 'RelSelf'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

assetmanagement.models.move_asset_request module

Asset Management API

Service for configuring, reading and managing assets, asset ~ and aspect types. # noqa: E501

class MoveAssetRequest(if_match=None, id=None, move_parameters=None)

Bases: object

Attributes:

attribute_types (dict): The key is attribute name

and the value is attribute type.

attribute_map (dict): The key is attribute name

and the value is json key in definition.

attribute_map = {'id': 'id', 'if_match': 'If-Match', 'move_parameters': 'moveParameters'}

attribute_types = {'id': 'str', 'if_match': 'str', 'move_parameters': 'AssetMove'}

id

Gets the id of this MoveAssetRequest.

Returns:The id of this MoveAssetRequest. Return type:str

if_match

Gets the if_match of this MoveAssetRequest.

Returns:The if_match of this MoveAssetRequest. Return type:str

move_parameters

Gets the move_parameters of this MoveAssetRequest.

Returns:The move_parameters of this MoveAssetRequest. Return type:AssetMove

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

assetmanagement.models.page module

Asset Management API

Service for configuring, reading and managing assets, asset ~ and aspect types. # noqa: E501

class Page(size=None, total_elements=None, total_pages=None, number=None)

Bases: object

Attributes:

attribute_types (dict): The key is attribute name

and the value is attribute type.

attribute_map (dict): The key is attribute name

and the value is json key in definition.

attribute_map = {'number': 'number', 'size': 'size', 'total_elements': 'totalElements', 'total_pages': 'totalPages'}

attribute_types = {'number': 'int', 'size': 'int', 'total_elements': 'int', 'total_pages': 'int'}

number

Gets the number of this Page.

Returns:The number of this Page. Return type:int

size

Gets the size of this Page.

Returns:The size of this Page. Return type:int

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

total_elements

Gets the total_elements of this Page.

Returns:The total_elements of this Page. Return type:int

total_pages

Gets the total_pages of this Page.

Returns:The total_pages of this Page. Return type:int

assetmanagement.models.paging_links module

Asset Management API

Service for configuring, reading and managing assets, asset ~ and aspect types. # noqa: E501

class PagingLinks(_self=None, first=None, prev=None, next=None, last=None)

Bases: object

Attributes:

attribute_types (dict): The key is attribute name

and the value is attribute type.

attribute_map (dict): The key is attribute name

and the value is json key in definition.

_self

Gets the _self of this PagingLinks.

Returns:The _self of this PagingLinks. Return type:RelSelf

attribute_map = {'_self': 'self', 'first': 'first', 'last': 'last', 'next': 'next', 'prev': 'prev'}

attribute_types = {'_self': 'RelSelf', 'first': 'LinkForDownloadingTheFile', 'last': 'LinkForDownloadingTheFile', 'next': 'LinkForDownloadingTheFile', 'prev': 'LinkForDownloadingTheFile'}

first

Gets the first of this PagingLinks.

Returns:The first of this PagingLinks. Return type:LinkForDownloadingTheFile

last

Gets the last of this PagingLinks.

Returns:The last of this PagingLinks. Return type:LinkForDownloadingTheFile

next

Gets the next of this PagingLinks.

Returns:The next of this PagingLinks. Return type:LinkForDownloadingTheFile

prev

Gets the prev of this PagingLinks.

Returns:The prev of this PagingLinks. Return type:LinkForDownloadingTheFile

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

assetmanagement.models.rel_self module

Asset Management API

Service for configuring, reading and managing assets, asset ~ and aspect types. # noqa: E501

class RelSelf(href=None)

Bases: object

Attributes:

attribute_types (dict): The key is attribute name

and the value is attribute type.

attribute_map (dict): The key is attribute name

and the value is json key in definition.

attribute_map = {'href': 'href'}

attribute_types = {'href': 'str'}

href

Gets the href of this RelSelf.

Returns:The href of this RelSelf. Return type:str

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

assetmanagement.models.replace_asset_request module

Asset Management API

Service for configuring, reading and managing assets, asset ~ and aspect types. # noqa: E501

class ReplaceAssetRequest(if_match=None, id=None, asset=None)

Bases: object

Attributes:

attribute_types (dict): The key is attribute name

and the value is attribute type.

attribute_map (dict): The key is attribute name

and the value is json key in definition.

asset

Gets the asset of this ReplaceAssetRequest.

Returns:The asset of this ReplaceAssetRequest. Return type:AssetUpdate

attribute_map = {'asset': 'asset', 'id': 'id', 'if_match': 'If-Match'}

attribute_types = {'asset': 'AssetUpdate', 'id': 'str', 'if_match': 'str'}

id

Gets the id of this ReplaceAssetRequest.

Returns:The id of this ReplaceAssetRequest. Return type:str

if_match

Gets the if_match of this ReplaceAssetRequest.

Returns:The if_match of this ReplaceAssetRequest. Return type:str

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

assetmanagement.models.replace_file_request module

Asset Management API

Service for configuring, reading and managing assets, asset ~ and aspect types. # noqa: E501

class ReplaceFileRequest(if_match=None, file=None, scope=None, name=None, description=None, file_id=None)

Bases: object

Attributes:

attribute_types (dict): The key is attribute name

and the value is attribute type.

attribute_map (dict): The key is attribute name

and the value is json key in definition.

attribute_map = {'description': 'description', 'file': 'file', 'file_id': 'fileId', 'if_match': 'If-Match', 'name': 'name', 'scope': 'scope'}

attribute_types = {'description': 'str', 'file': 'file', 'file_id': 'str', 'if_match': 'str', 'name': 'str', 'scope': 'str'}

description

Gets the description of this ReplaceFileRequest.

Returns:The description of this ReplaceFileRequest. Return type:str

file

Gets the file of this ReplaceFileRequest.

Returns:The file of this ReplaceFileRequest. Return type:file

file_id

Gets the file_id of this ReplaceFileRequest.

Returns:The file_id of this ReplaceFileRequest. Return type:str

if_match

Gets the if_match of this ReplaceFileRequest.

Returns:The if_match of this ReplaceFileRequest. Return type:str

name

Gets the name of this ReplaceFileRequest.

Returns:The name of this ReplaceFileRequest. Return type:str

scope

Gets the scope of this ReplaceFileRequest.

Returns:The scope of this ReplaceFileRequest. Return type:str

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

assetmanagement.models.root_asset_resource module

Asset Management API

Service for configuring, reading and managing assets, asset ~ and aspect types. # noqa: E501

class RootAssetResource(name=None, external_id=None, description=None, location=None, variables=None, aspects=None, file_assignments=None, type_id=None, parent_id=None, timezone=None, twin_type='performance', tenant_id=None, sub_tenant=None, t2_tenant=None, asset_id=None, locks=None, deleted=None, etag=None, links=None, hierarchy_path=None)

Bases: object

Attributes:

attribute_types (dict): The key is attribute name

and the value is attribute type.

attribute_map (dict): The key is attribute name

and the value is json key in definition.

aspects

Gets the aspects of this RootAssetResource.

Returns:The aspects of this RootAssetResource. Return type:list[Aspect]

asset_id

Gets the asset_id of this RootAssetResource.

Returns:The asset_id of this RootAssetResource. Return type:UniqueId

attribute_map = {'aspects': 'aspects', 'asset_id': 'assetId', 'deleted': 'deleted', 'description': 'description', 'etag': 'etag', 'external_id': 'externalId', 'file_assignments': 'fileAssignments', 'hierarchy_path': 'hierarchyPath', 'links': '_links', 'location': 'location', 'locks': 'locks', 'name': 'name', 'parent_id': 'parentId', 'sub_tenant': 'subTenant', 't2_tenant': 't2Tenant', 'tenant_id': 'tenantId', 'timezone': 'timezone', 'twin_type': 'twinType', 'type_id': 'typeId', 'variables': 'variables'}

attribute_types = {'aspects': 'list[Aspect]', 'asset_id': 'UniqueId', 'deleted': 'datetime', 'description': 'str', 'etag': 'ETag', 'external_id': 'str', 'file_assignments': 'list[FileAssignmentResource]', 'hierarchy_path': 'list[str]', 'links': 'AssetLinks', 'location': 'Location', 'locks': 'list[LockResource]', 'name': 'str', 'parent_id': 'UniqueId', 'sub_tenant': 'str', 't2_tenant': 'str', 'tenant_id': 'TenantId', 'timezone': 'Timezone', 'twin_type': 'str', 'type_id': 'AssetTypeId', 'variables': 'list[Variable]'}

deleted

Gets the deleted of this RootAssetResource.

Returns:The deleted of this RootAssetResource. Return type:datetime

description

Gets the description of this RootAssetResource. The description of the asset

Returns:The description of this RootAssetResource. Return type:str

etag

Gets the etag of this RootAssetResource.

Returns:The etag of this RootAssetResource. Return type:ETag

external_id

Gets the external_id of this RootAssetResource. The id given by the user

Returns:The external_id of this RootAssetResource. Return type:str

file_assignments

Gets the file_assignments of this RootAssetResource.

Returns:The file_assignments of this RootAssetResource. Return type:list[FileAssignmentResource]

hierarchy_path

Gets the hierarchy_path of this RootAssetResource. Hieararchy path is empty for the root asset

Returns:The hierarchy_path of this RootAssetResource. Return type:list[str]

links

Gets the links of this RootAssetResource.

Returns:The links of this RootAssetResource. Return type:AssetLinks

location

Gets the location of this RootAssetResource.

Returns:The location of this RootAssetResource. Return type:Location

locks

Gets the locks of this RootAssetResource.

Returns:The locks of this RootAssetResource. Return type:list[LockResource]

name

Gets the name of this RootAssetResource. Name of the asset

Returns:The name of this RootAssetResource. Return type:str

parent_id

Gets the parent_id of this RootAssetResource.

Returns:The parent_id of this RootAssetResource. Return type:UniqueId

sub_tenant

Gets the sub_tenant of this RootAssetResource. The id of the end-customer.

Returns:The sub_tenant of this RootAssetResource. Return type:str

t2_tenant

Gets the t2_tenant of this RootAssetResource. The id of the end-customer. This field is DEPRECATED please use subTenant instead.

Returns:The t2_tenant of this RootAssetResource. Return type:str

tenant_id

Gets the tenant_id of this RootAssetResource.

Returns:The tenant_id of this RootAssetResource. Return type:TenantId

timezone

Gets the timezone of this RootAssetResource.

Returns:The timezone of this RootAssetResource. Return type:Timezone

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

twin_type

Gets the twin_type of this RootAssetResource.

Returns:The twin_type of this RootAssetResource. Return type:str

type_id

Gets the type_id of this RootAssetResource.

Returns:The type_id of this RootAssetResource. Return type:AssetTypeId

variables

Gets the variables of this RootAssetResource.

Returns:The variables of this RootAssetResource. Return type:list[Variable]

assetmanagement.models.save_aspect_type_request module

Asset Management API

Service for configuring, reading and managing assets, asset ~ and aspect types. # noqa: E501

class SaveAspectTypeRequest(if_none_match=None, aspecttype=None, if_match=None, id=None)

Bases: object

Attributes:

attribute_types (dict): The key is attribute name

and the value is attribute type.

attribute_map (dict): The key is attribute name

and the value is json key in definition.

aspecttype

Gets the aspecttype of this SaveAspectTypeRequest.

Returns:The aspecttype of this SaveAspectTypeRequest. Return type:AspectType

attribute_map = {'aspecttype': 'aspecttype', 'id': 'id', 'if_match': 'If-Match', 'if_none_match': 'If-None-Match'}

attribute_types = {'aspecttype': 'AspectType', 'id': 'str', 'if_match': 'str', 'if_none_match': 'str'}

id

Gets the id of this SaveAspectTypeRequest.

Returns:The id of this SaveAspectTypeRequest. Return type:str

if_match

Gets the if_match of this SaveAspectTypeRequest.

Returns:The if_match of this SaveAspectTypeRequest. Return type:str

if_none_match

Gets the if_none_match of this SaveAspectTypeRequest.

Returns:The if_none_match of this SaveAspectTypeRequest. Return type:str

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

assetmanagement.models.save_asset_file_assignment_request module

Asset Management API

Service for configuring, reading and managing assets, asset ~ and aspect types. # noqa: E501

class SaveAssetFileAssignmentRequest(if_match=None, assignment=None, id=None, key=None)

Bases: object

Attributes:

attribute_types (dict): The key is attribute name

and the value is attribute type.

attribute_map (dict): The key is attribute name

and the value is json key in definition.

assignment

Gets the assignment of this SaveAssetFileAssignmentRequest.

Returns:The assignment of this SaveAssetFileAssignmentRequest. Return type:KeyedFileAssignment

attribute_map = {'assignment': 'assignment', 'id': 'id', 'if_match': 'If-Match', 'key': 'key'}

attribute_types = {'assignment': 'KeyedFileAssignment', 'id': 'str', 'if_match': 'str', 'key': 'str'}

id

Gets the id of this SaveAssetFileAssignmentRequest.

Returns:The id of this SaveAssetFileAssignmentRequest. Return type:str

if_match

Gets the if_match of this SaveAssetFileAssignmentRequest.

Returns:The if_match of this SaveAssetFileAssignmentRequest. Return type:str

key

Gets the key of this SaveAssetFileAssignmentRequest.

Returns:The key of this SaveAssetFileAssignmentRequest. Return type:str

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

assetmanagement.models.save_asset_location_request module

Asset Management API

Service for configuring, reading and managing assets, asset ~ and aspect types. # noqa: E501

class SaveAssetLocationRequest(if_match=None, location=None, id=None)

Bases: object

Attributes:

attribute_types (dict): The key is attribute name

and the value is attribute type.

attribute_map (dict): The key is attribute name

and the value is json key in definition.

attribute_map = {'id': 'id', 'if_match': 'If-Match', 'location': 'location'}

attribute_types = {'id': 'str', 'if_match': 'str', 'location': 'Location'}

id

Gets the id of this SaveAssetLocationRequest.

Returns:The id of this SaveAssetLocationRequest. Return type:str

if_match

Gets the if_match of this SaveAssetLocationRequest.

Returns:The if_match of this SaveAssetLocationRequest. Return type:str

location

Gets the location of this SaveAssetLocationRequest.

Returns:The location of this SaveAssetLocationRequest. Return type:Location

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

assetmanagement.models.save_asset_type_file_assignment_request module

Asset Management API

Service for configuring, reading and managing assets, asset ~ and aspect types. # noqa: E501

class SaveAssetTypeFileAssignmentRequest(if_match=None, assignment=None, id=None, key=None)

Bases: object

Attributes:

attribute_types (dict): The key is attribute name

and the value is attribute type.

attribute_map (dict): The key is attribute name

and the value is json key in definition.

assignment

Gets the assignment of this SaveAssetTypeFileAssignmentRequest.

Returns:The assignment of this SaveAssetTypeFileAssignmentRequest. Return type:KeyedFileAssignment

attribute_map = {'assignment': 'assignment', 'id': 'id', 'if_match': 'If-Match', 'key': 'key'}

attribute_types = {'assignment': 'KeyedFileAssignment', 'id': 'str', 'if_match': 'str', 'key': 'str'}

id

Gets the id of this SaveAssetTypeFileAssignmentRequest.

Returns:The id of this SaveAssetTypeFileAssignmentRequest. Return type:str

if_match

Gets the if_match of this SaveAssetTypeFileAssignmentRequest.

Returns:The if_match of this SaveAssetTypeFileAssignmentRequest. Return type:str

key

Gets the key of this SaveAssetTypeFileAssignmentRequest.

Returns:The key of this SaveAssetTypeFileAssignmentRequest. Return type:str

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

assetmanagement.models.save_asset_type_request module

Asset Management API

Service for configuring, reading and managing assets, asset ~ and aspect types. # noqa: E501

class SaveAssetTypeRequest(if_none_match=None, if_match=None, exploded=None, id=None, assettype=None)

Bases: object

Attributes:

attribute_types (dict): The key is attribute name

and the value is attribute type.

attribute_map (dict): The key is attribute name

and the value is json key in definition.

assettype

Gets the assettype of this SaveAssetTypeRequest.

Returns:The assettype of this SaveAssetTypeRequest. Return type:AssetType

attribute_map = {'assettype': 'assettype', 'exploded': 'exploded', 'id': 'id', 'if_match': 'If-Match', 'if_none_match': 'If-None-Match'}

attribute_types = {'assettype': 'AssetType', 'exploded': 'bool', 'id': 'str', 'if_match': 'str', 'if_none_match': 'str'}

exploded

Gets the exploded of this SaveAssetTypeRequest.

Returns:The exploded of this SaveAssetTypeRequest. Return type:bool

id

Gets the id of this SaveAssetTypeRequest.

Returns:The id of this SaveAssetTypeRequest. Return type:str

if_match

Gets the if_match of this SaveAssetTypeRequest.

Returns:The if_match of this SaveAssetTypeRequest. Return type:str

if_none_match

Gets the if_none_match of this SaveAssetTypeRequest.

Returns:The if_none_match of this SaveAssetTypeRequest. Return type:str

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

assetmanagement.models.tenant_id module

Asset Management API

Service for configuring, reading and managing assets, asset ~ and aspect types. # noqa: E501

class TenantId

Bases: object

Attributes:

attribute_types (dict): The key is attribute name

and the value is attribute type.

attribute_map (dict): The key is attribute name

and the value is json key in definition.

attribute_map = {}

attribute_types = {}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

assetmanagement.models.timezone module

Asset Management API

Service for configuring, reading and managing assets, asset ~ and aspect types. # noqa: E501

class Timezone

Bases: object

Attributes:

attribute_types (dict): The key is attribute name

and the value is attribute type.

attribute_map (dict): The key is attribute name

and the value is json key in definition.

attribute_map = {}

attribute_types = {}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

assetmanagement.models.twin_type module

Asset Management API

Service for configuring, reading and managing assets, asset ~ and aspect types. # noqa: E501

class TwinType

Bases: object

allowed enum values

PERFORMANCE = 'performance'

SIMULATION = 'simulation'

Attributes:

attribute_types (dict): The key is attribute name

and the value is attribute type.

attribute_map (dict): The key is attribute name

and the value is json key in definition.

attribute_map = {}

attribute_types = {}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

assetmanagement.models.unique_id module

Asset Management API

Service for configuring, reading and managing assets, asset ~ and aspect types. # noqa: E501

class UniqueId

Bases: object

Attributes:

attribute_types (dict): The key is attribute name

and the value is attribute type.

attribute_map (dict): The key is attribute name

and the value is json key in definition.

attribute_map = {}

attribute_types = {}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

assetmanagement.models.update_aspect_type_request module

Asset Management API

Service for configuring, reading and managing assets, asset ~ and aspect types. # noqa: E501

class UpdateAspectTypeRequest(aspecttype=None, if_match=None, id=None)

Bases: object

Attributes:

attribute_types (dict): The key is attribute name

and the value is attribute type.

attribute_map (dict): The key is attribute name

and the value is json key in definition.

aspecttype

Gets the aspecttype of this UpdateAspectTypeRequest.

Returns:The aspecttype of this UpdateAspectTypeRequest. Return type:AspectType

attribute_map = {'aspecttype': 'aspecttype', 'id': 'id', 'if_match': 'If-Match'}

attribute_types = {'aspecttype': 'AspectType', 'id': 'str', 'if_match': 'str'}

id

Gets the id of this UpdateAspectTypeRequest.

Returns:The id of this UpdateAspectTypeRequest. Return type:str

if_match

Gets the if_match of this UpdateAspectTypeRequest.

Returns:The if_match of this UpdateAspectTypeRequest. Return type:str

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

assetmanagement.models.update_asset_request module

Asset Management API

Service for configuring, reading and managing assets, asset ~ and aspect types. # noqa: E501

class UpdateAssetRequest(if_match=None, id=None, asset=None)

Bases: object

Attributes:

attribute_types (dict): The key is attribute name

and the value is attribute type.

attribute_map (dict): The key is attribute name

and the value is json key in definition.

asset

Gets the asset of this UpdateAssetRequest.

Returns:The asset of this UpdateAssetRequest. Return type:AssetUpdate

attribute_map = {'asset': 'asset', 'id': 'id', 'if_match': 'If-Match'}

attribute_types = {'asset': 'AssetUpdate', 'id': 'str', 'if_match': 'str'}

id

Gets the id of this UpdateAssetRequest.

Returns:The id of this UpdateAssetRequest. Return type:str

if_match

Gets the if_match of this UpdateAssetRequest.

Returns:The if_match of this UpdateAssetRequest. Return type:str

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

assetmanagement.models.update_asset_type_request module

Asset Management API

Service for configuring, reading and managing assets, asset ~ and aspect types. # noqa: E501

class UpdateAssetTypeRequest(if_match=None, exploded=None, id=None, assettype=None)

Bases: object

Attributes:

attribute_types (dict): The key is attribute name

and the value is attribute type.

attribute_map (dict): The key is attribute name

and the value is json key in definition.

assettype

Gets the assettype of this UpdateAssetTypeRequest.

Returns:The assettype of this UpdateAssetTypeRequest. Return type:AssetType

attribute_map = {'assettype': 'assettype', 'exploded': 'exploded', 'id': 'id', 'if_match': 'If-Match'}

attribute_types = {'assettype': 'AssetType', 'exploded': 'bool', 'id': 'str', 'if_match': 'str'}

exploded

Gets the exploded of this UpdateAssetTypeRequest.

Returns:The exploded of this UpdateAssetTypeRequest. Return type:bool

id

Gets the id of this UpdateAssetTypeRequest.

Returns:The id of this UpdateAssetTypeRequest. Return type:str

if_match

Gets the if_match of this UpdateAssetTypeRequest.

Returns:The if_match of this UpdateAssetTypeRequest. Return type:str

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

assetmanagement.models.upload_file_request module

Asset Management API

Service for configuring, reading and managing assets, asset ~ and aspect types. # noqa: E501

class UploadFileRequest(file=None, scope=None, name=None, description=None)

Bases: object

Attributes:

attribute_types (dict): The key is attribute name

and the value is attribute type.

attribute_map (dict): The key is attribute name

and the value is json key in definition.

attribute_map = {'description': 'description', 'file': 'file', 'name': 'name', 'scope': 'scope'}

attribute_types = {'description': 'str', 'file': 'file', 'name': 'str', 'scope': 'str'}

description

Gets the description of this UploadFileRequest.

Returns:The description of this UploadFileRequest. Return type:str

file

Gets the file of this UploadFileRequest.

Returns:The file of this UploadFileRequest. Return type:file

name

Gets the name of this UploadFileRequest.

Returns:The name of this UploadFileRequest. Return type:str

scope

Gets the scope of this UploadFileRequest.

Returns:The scope of this UploadFileRequest. Return type:str

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

assetmanagement.models.uuid module

Asset Management API

Service for configuring, reading and managing assets, asset ~ and aspect types. # noqa: E501

class UUID

Bases: object

Attributes:

attribute_types (dict): The key is attribute name

and the value is attribute type.

attribute_map (dict): The key is attribute name

and the value is json key in definition.

attribute_map = {}

attribute_types = {}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

assetmanagement.models.variable module

Asset Management API

Service for configuring, reading and managing assets, asset ~ and aspect types. # noqa: E501

class Variable(name=None, value=None)

Bases: object

Attributes:

attribute_types (dict): The key is attribute name

and the value is attribute type.

attribute_map (dict): The key is attribute name

and the value is json key in definition.

attribute_map = {'name': 'name', 'value': 'value'}

attribute_types = {'name': 'str', 'value': 'str'}

name

Gets the name of this Variable.

Returns:The name of this Variable. Return type:str

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

value

Gets the value of this Variable.

Returns:The value of this Variable. Return type:str

assetmanagement.models.variable_definition module

Asset Management API

Service for configuring, reading and managing assets, asset ~ and aspect types. # noqa: E501

class VariableDefinition(name=None, data_type=None, unit=None, searchable=False, length=None, default_value=None)

Bases: object

Attributes:

attribute_types (dict): The key is attribute name

and the value is attribute type.

attribute_map (dict): The key is attribute name

and the value is json key in definition.

attribute_map = {'data_type': 'dataType', 'default_value': 'defaultValue', 'length': 'length', 'name': 'name', 'searchable': 'searchable', 'unit': 'unit'}

attribute_types = {'data_type': 'str', 'default_value': 'str', 'length': 'int', 'name': 'str', 'searchable': 'bool', 'unit': 'str'}

data_type

Gets the data_type of this VariableDefinition. Data type of the variable. BIG_STRING could only be used by variables in dynamic aspect-types. Cannot be changed.

Returns:The data_type of this VariableDefinition. Return type:str

default_value

Gets the default_value of this VariableDefinition. The default value of the variable. It must be compatible with the dataType! The default value will be inherited by the asset type’s child types and by the asset instantiating it. It can be defined in aspect types and asset types.

Returns:The default_value of this VariableDefinition. Return type:str

length

Gets the length of this VariableDefinition. The max length of the variable’s value. The length field is only used for variables of string or big_string dataType. Max length for string is 255 and max length for big_string 100000. Cannot be changed.

Returns:The length of this VariableDefinition. Return type:int

name

Gets the name of this VariableDefinition. Name of the variable. Once set cannot be changed. Reserved words (id, name, description, tenant, etag, scope, properties, propertySets, extends, variables, aspects, parentTypeId) cannot be used as variable names.

Returns:The name of this VariableDefinition. Return type:str

searchable

Gets the searchable of this VariableDefinition. Indicates whether sorting and filtering is allowed on this variable. Only usable for static properties. Cannot be changed.

Returns:The searchable of this VariableDefinition. Return type:bool

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

unit

Gets the unit of this VariableDefinition. Unit of measurement. Cannot be changed.

Returns:The unit of this VariableDefinition. Return type:str

assetmanagement.models.variable_definition_resource module

Asset Management API

Service for configuring, reading and managing assets, asset ~ and aspect types. # noqa: E501

class VariableDefinitionResource(name=None, data_type=None, unit=None, searchable=False, length=None, default_value=None, links=None)

Bases: object

Attributes:

attribute_types (dict): The key is attribute name

and the value is attribute type.

attribute_map (dict): The key is attribute name

and the value is json key in definition.

attribute_map = {'data_type': 'dataType', 'default_value': 'defaultValue', 'length': 'length', 'links': '_links', 'name': 'name', 'searchable': 'searchable', 'unit': 'unit'}

attribute_types = {'data_type': 'str', 'default_value': 'str', 'length': 'int', 'links': 'VariableDefinitionResourceLinks', 'name': 'str', 'searchable': 'bool', 'unit': 'str'}

data_type

Gets the data_type of this VariableDefinitionResource. Data type of the variable. BIG_STRING could only be used by variables in dynamic aspect-types. Cannot be changed.

Returns:The data_type of this VariableDefinitionResource. Return type:str

default_value

Gets the default_value of this VariableDefinitionResource. The default value of the variable. It must be compatible with the dataType! The default value will be inherited by the asset type’s child types and by the asset instantiating it. It can be defined in aspect types and asset types.

Returns:The default_value of this VariableDefinitionResource. Return type:str

length

Gets the length of this VariableDefinitionResource. The max length of the variable’s value. The length field is only used for variables of string or big_string dataType. Max length for string is 255 and max length for big_string 100000. Cannot be changed.

Returns:The length of this VariableDefinitionResource. Return type:int

links

Gets the links of this VariableDefinitionResource.

Returns:The links of this VariableDefinitionResource. Return type:VariableDefinitionResourceLinks

name

Gets the name of this VariableDefinitionResource. Name of the variable. Once set cannot be changed. Reserved words (id, name, description, tenant, etag, scope, properties, propertySets, extends, variables, aspects, parentTypeId) cannot be used as variable names.

Returns:The name of this VariableDefinitionResource. Return type:str

searchable

Gets the searchable of this VariableDefinitionResource. Indicates whether sorting and filtering is allowed on this variable. Only usable for static properties. Cannot be changed.

Returns:The searchable of this VariableDefinitionResource. Return type:bool

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

unit

Gets the unit of this VariableDefinitionResource. Unit of measurement. Cannot be changed.

Returns:The unit of this VariableDefinitionResource. Return type:str

assetmanagement.models.variable_definition_resource_links module

Asset Management API

Service for configuring, reading and managing assets, asset ~ and aspect types. # noqa: E501

class VariableDefinitionResourceLinks(origin=None)

Bases: object

Attributes:

attribute_types (dict): The key is attribute name

and the value is attribute type.

attribute_map (dict): The key is attribute name

and the value is json key in definition.

attribute_map = {'origin': 'origin'}

attribute_types = {'origin': 'VariableDefinitionResourceLinksOrigin'}

origin

Gets the origin of this VariableDefinitionResourceLinks.

Returns:The origin of this VariableDefinitionResourceLinks. Return type:VariableDefinitionResourceLinksOrigin

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

assetmanagement.models.variable_definition_resource_links_origin module

Asset Management API

Service for configuring, reading and managing assets, asset ~ and aspect types. # noqa: E501

class VariableDefinitionResourceLinksOrigin(href=None)

Bases: object

Attributes:

attribute_types (dict): The key is attribute name

and the value is attribute type.

attribute_map (dict): The key is attribute name

and the value is json key in definition.

attribute_map = {'href': 'href'}

attribute_types = {'href': 'str'}

href

Gets the href of this VariableDefinitionResourceLinksOrigin.

Returns:The href of this VariableDefinitionResourceLinksOrigin. Return type:str

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

assetmanagement.models.variable_list_resource module

Asset Management API

Service for configuring, reading and managing assets, asset ~ and aspect types. # noqa: E501

class VariableListResource(embedded=None, page=None, links=None)

Bases: object

Attributes:

attribute_types (dict): The key is attribute name

and the value is attribute type.

attribute_map (dict): The key is attribute name

and the value is json key in definition.

attribute_map = {'embedded': '_embedded', 'links': '_links', 'page': 'page'}

attribute_types = {'embedded': 'VariableListResourceEmbedded', 'links': 'PagingLinks', 'page': 'Page'}

embedded

Gets the embedded of this VariableListResource.

Returns:The embedded of this VariableListResource. Return type:VariableListResourceEmbedded

links

Gets the links of this VariableListResource.

Returns:The links of this VariableListResource. Return type:PagingLinks

page

Gets the page of this VariableListResource.

Returns:The page of this VariableListResource. Return type:Page

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

assetmanagement.models.variable_list_resource_embedded module

Asset Management API

Service for configuring, reading and managing assets, asset ~ and aspect types. # noqa: E501

class VariableListResourceEmbedded(variables=None)

Bases: object

Attributes:

attribute_types (dict): The key is attribute name

and the value is attribute type.

attribute_map (dict): The key is attribute name

and the value is json key in definition.

attribute_map = {'variables': 'variables'}

attribute_types = {'variables': 'list[VariableDefinition]'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

variables

Gets the variables of this VariableListResourceEmbedded.

Returns:The variables of this VariableListResourceEmbedded. Return type:list[VariableDefinition]

Module contents

Asset Management API

Service for configuring, reading and managing assets, asset ~ and aspect types. # noqa: E501