@mindconnect/mindconnect-nodejs
Version:
MindConnect Library for NodeJS (community based)
1,832 lines (1,831 loc) • 45.9 kB
TypeScript
export declare namespace AssetManagementModels {
/**
*
* @export
* @interface Aspect
*/
interface Aspect {
/**
*
* @type {string}
* @memberof Aspect
*/
name?: string;
/**
*
* @type {Array<Variable>}
* @memberof Aspect
*/
variables?: Array<Variable>;
}
/**
*
* @export
* @interface AspectLinks
*/
interface AspectLinks {
/**
*
* @type {AspectLinksSelf}
* @memberof AspectLinks
*/
self?: AspectLinksSelf;
/**
*
* @type {AspectLinksAsset}
* @memberof AspectLinks
*/
asset?: AspectLinksAsset;
/**
*
* @type {AspectLinksAspectType}
* @memberof AspectLinks
*/
aspectType?: AspectLinksAspectType;
}
/**
*
* @export
* @interface AspectLinksAspectType
*/
interface AspectLinksAspectType {
/**
* Link to the origin aspect type of the aspect
* @type {string}
* @memberof AspectLinksAspectType
*/
href?: string;
}
/**
*
* @export
* @interface AspectLinksAsset
*/
interface AspectLinksAsset {
/**
* Link to the asset
* @type {string}
* @memberof AspectLinksAsset
*/
href?: string;
}
/**
*
* @export
* @interface AspectLinksSelf
*/
interface AspectLinksSelf {
/**
* Link to the aspect
* @type {string}
* @memberof AspectLinksSelf
*/
href?: string;
}
/**
*
* @export
* @interface AspectListResource
*/
interface AspectListResource {
/**
*
* @type {AspectListResourceEmbedded}
* @memberof AspectListResource
*/
_embedded?: AspectListResourceEmbedded;
/**
*
* @type {Page}
* @memberof AspectListResource
*/
page?: Page;
/**
*
* @type {PagingLinks}
* @memberof AspectListResource
*/
_links?: PagingLinks;
}
/**
*
* @export
* @interface AspectListResourceEmbedded
*/
interface AspectListResourceEmbedded {
/**
*
* @type {Array<AspectResource>}
* @memberof AspectListResourceEmbedded
*/
aspects?: Array<AspectResource>;
}
/**
*
* @export
* @interface AspectResource
*/
interface AspectResource {
/**
* ID of the Aspect type
* @type {string}
* @memberof AspectResource
*/
aspectTypeId?: string;
/**
*
* @type {UniqueId}
* @memberof AspectResource
*/
holderAssetId?: UniqueId;
/**
* Name of the aspect
* @type {string}
* @memberof AspectResource
*/
name: string;
/**
*
* @type {string}
* @memberof AspectResource
*/
category?: AspectResource.CategoryEnum;
/**
* The description of the aspect
* @type {string}
* @memberof AspectResource
*/
description?: string;
/**
*
* @type {Array<AspectVariable>}
* @memberof AspectResource
*/
variables?: Array<AspectVariable>;
/**
*
* @type {AspectLinks}
* @memberof AspectResource
*/
_links?: AspectLinks;
}
/**
* @export
* @namespace AspectResource
*/
namespace AspectResource {
/**
* @export
* @enum {string}
*/
enum CategoryEnum {
Dynamic,
Static
}
}
/**
*
* @export
* @interface AspectType
*/
interface AspectType {
/**
* Name of the aspect type. It has to be unique inside the tenant and cannot be changed later.
* @type {string}
* @memberof AspectType
*/
name: string;
/**
* If the aspect-type is used for static data or time-series. Cannot be changed once the aspect-type is created.
* @type {string}
* @memberof AspectType
*/
category: AspectType.CategoryEnum;
/**
* 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.
* @type {string}
* @memberof AspectType
*/
scope?: AspectType.ScopeEnum;
/**
* The description of the aspect type
* @type {string}
* @memberof AspectType
*/
description?: string;
/**
* 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.
* @type {Array<AspectVariable>}
* @memberof AspectType
*/
variables: Array<AspectVariable>;
}
/**
* @export
* @namespace AspectType
*/
namespace AspectType {
/**
* @export
* @enum {string}
*/
enum CategoryEnum {
Static,
Dynamic
}
/**
* @export
* @enum {string}
*/
enum ScopeEnum {
Public,
Private
}
}
/**
* The aspect type's id is a unique identifier. The id's length must be between 1 and 128 characters and matches the following symbols \"A-Z\", \"a-z\", \"0-9\", \"_\" and \".\" beginning with the tenant prefix what has a maximum of 8 characters. (e.g . ten_pref.type_id). Once set cannot be changed.
* @export
* @interface AspectTypeId
*/
interface AspectTypeId {
}
/**
*
* @export
* @interface AspectTypeLinks
*/
interface AspectTypeLinks {
/**
*
* @type {RelSelf}
* @memberof AspectTypeLinks
*/
self?: RelSelf;
}
/**
*
* @export
* @interface AspectTypeListResource
*/
interface AspectTypeListResource {
/**
*
* @type {AspectTypeListResourceEmbedded}
* @memberof AspectTypeListResource
*/
_embedded?: AspectTypeListResourceEmbedded;
/**
*
* @type {Page}
* @memberof AspectTypeListResource
*/
page?: Page;
/**
*
* @type {PagingLinks}
* @memberof AspectTypeListResource
*/
_links?: PagingLinks;
}
/**
*
* @export
* @interface AspectTypeListResourceEmbedded
*/
interface AspectTypeListResourceEmbedded {
/**
*
* @type {Array<AspectTypeResource>}
* @memberof AspectTypeListResourceEmbedded
*/
aspectTypes?: Array<AspectTypeResource>;
}
/**
*
* @export
* @interface AspectTypeResource
*/
interface AspectTypeResource extends AspectType {
/**
*
* @type {AspectTypeId}
* @memberof AspectTypeResource
*/
id?: AspectTypeId;
/**
*
* @type {TenantId}
* @memberof AspectTypeResource
*/
tenantId?: TenantId;
/**
*
* @type {ETag}
* @memberof AspectTypeResource
*/
etag?: ETag;
/**
*
* @type {AspectTypeLinks}
* @memberof AspectTypeResource
*/
_links?: AspectTypeLinks;
}
/**
* @export
* @namespace AspectTypeResource
*/
namespace AspectTypeResource { }
/**
*
* @export
* @interface AspectVariable
*/
interface AspectVariable extends VariableDefinition {
/**
* Indicates whether the variable has quality code. Cannot be changed.
* @type {boolean}
* @memberof AspectVariable
*/
qualityCode?: boolean;
}
/**
* @export
* @namespace AspectVariable
*/
namespace AspectVariable { }
/**
*
* @export
* @interface Asset
*/
interface Asset extends AssetUpdate {
/**
*
* @type {AssetTypeId}
* @memberof Asset
*/
typeId?: AssetTypeId;
/**
*
* @type {UniqueId}
* @memberof Asset
*/
parentId?: UniqueId;
/**
*
* @type {Timezone}
* @memberof Asset
*/
timezone?: Timezone;
/**
*
* @type {TwinType}
* @memberof Asset
*/
twinType?: TwinType;
}
/**
*
* @export
* @interface AssetLinks
*/
interface AssetLinks {
/**
*
* @type {AssetLinksSelf}
* @memberof AssetLinks
*/
self?: AssetLinksSelf;
/**
*
* @type {AssetLinksParent}
* @memberof AssetLinks
*/
parent?: AssetLinksParent;
/**
*
* @type {AssetLinksChildren}
* @memberof AssetLinks
*/
children?: AssetLinksChildren;
/**
*
* @type {AssetLinksVariables}
* @memberof AssetLinks
*/
variables?: AssetLinksVariables;
/**
*
* @type {AssetLinksAspects}
* @memberof AssetLinks
*/
aspects?: AssetLinksAspects;
/**
*
* @type {AssetLinksT2Tenant}
* @memberof AssetLinks
*/
t2Tenant?: AssetLinksT2Tenant;
/**
*
* @type {AssetLinksLocation}
* @memberof AssetLinks
*/
location?: AssetLinksLocation;
}
/**
*
* @export
* @interface AssetLinksAspects
*/
interface AssetLinksAspects {
/**
* URL to get the aspect structure of the asset
* @type {string}
* @memberof AssetLinksAspects
*/
href?: string;
}
/**
*
* @export
* @interface AssetLinksChildren
*/
interface AssetLinksChildren {
/**
* URL to get the children of the asset
* @type {string}
* @memberof AssetLinksChildren
*/
href?: string;
}
/**
*
* @export
* @interface AssetLinksLocation
*/
interface AssetLinksLocation {
/**
* URL to update or delete the location of the asset
* @type {string}
* @memberof AssetLinksLocation
*/
href?: string;
}
/**
*
* @export
* @interface AssetLinksParent
*/
interface AssetLinksParent {
/**
* URL to get the parent of the asset
* @type {string}
* @memberof AssetLinksParent
*/
href?: string;
}
/**
*
* @export
* @interface AssetLinksSelf
*/
interface AssetLinksSelf {
/**
* URL to get the asset
* @type {string}
* @memberof AssetLinksSelf
*/
href?: string;
}
/**
*
* @export
* @interface AssetLinksT2Tenant
*/
interface AssetLinksT2Tenant {
/**
* URL to get the end-customer of the asset
* @type {string}
* @memberof AssetLinksT2Tenant
*/
href?: string;
}
/**
*
* @export
* @interface AssetLinksVariables
*/
interface AssetLinksVariables {
/**
* URL to get the variable definitions of the asset
* @type {string}
* @memberof AssetLinksVariables
*/
href?: string;
}
/**
*
* @export
* @interface AssetListResource
*/
interface AssetListResource {
/**
*
* @type {AssetListResourceEmbedded}
* @memberof AssetListResource
*/
_embedded?: AssetListResourceEmbedded;
/**
*
* @type {Page}
* @memberof AssetListResource
*/
page?: Page;
/**
*
* @type {PagingLinks}
* @memberof AssetListResource
*/
_links?: PagingLinks;
}
/**
*
* @export
* @interface AssetListResourceEmbedded
*/
interface AssetListResourceEmbedded {
/**
*
* @type {Array<AssetResource>}
* @memberof AssetListResourceEmbedded
*/
assets?: Array<AssetResource>;
}
/**
*
* @export
* @interface AssetMove
*/
interface AssetMove {
/**
*
* @type {UniqueId}
* @memberof AssetMove
*/
newParentId: UniqueId;
}
/**
*
* @export
* @interface AssetResource
*/
interface AssetResource extends Asset {
/**
*
* @type {TenantId}
* @memberof AssetResource
*/
tenantId?: TenantId;
/**
* The id of the end-customer.
* @type {string}
* @memberof AssetResource
*/
subTenant?: string;
/**
* The id of the end-customer. This field is DEPRECATED please use subTenant instead.
* @type {string}
* @memberof AssetResource
*/
t2Tenant?: string;
/**
*
* @type {UniqueId}
* @memberof AssetResource
*/
assetId?: UniqueId;
/**
*
* @type {Array<FileAssignmentResource>}
* @memberof AssetResource
*/
fileAssignments?: Array<FileAssignmentResource>;
/**
*
* @type {Array<LockResource>}
* @memberof AssetResource
*/
locks?: Array<LockResource>;
/**
*
* @type {Date}
* @memberof AssetResource
*/
deleted?: Date;
/**
*
* @type {string}
* @memberof AssetResource
*/
twinType?: TwinType;
/**
*
* @type {ETag}
* @memberof AssetResource
*/
etag?: ETag;
/**
*
* @type {AssetLinks}
* @memberof AssetResource
*/
_links?: AssetLinks;
}
/**
* @export
* @namespace AssetResource
*/
namespace AssetResource {
/**
* @export
* @enum {string}
*/
enum TwinTypeEnum {
Performance,
Simulation
}
}
/**
*
* @export
* @interface AssetResourceWithHierarchyPath
*/
interface AssetResourceWithHierarchyPath extends AssetResource {
/**
*
* @type {Array<AssetResourceWithHierarchyPathHierarchyPath>}
* @memberof AssetResourceWithHierarchyPath
*/
hierarchyPath?: Array<AssetResourceWithHierarchyPathHierarchyPath>;
}
/**
* @export
* @namespace AssetResourceWithHierarchyPath
*/
namespace AssetResourceWithHierarchyPath { }
/**
*
* @export
* @interface AssetResourceWithHierarchyPathHierarchyPath
*/
interface AssetResourceWithHierarchyPathHierarchyPath {
/**
*
* @type {UniqueId}
* @memberof AssetResourceWithHierarchyPathHierarchyPath
*/
assetId?: UniqueId;
/**
* Name of the asset
* @type {string}
* @memberof AssetResourceWithHierarchyPathHierarchyPath
*/
name?: string;
}
/**
*
* @export
* @interface AssetType
*/
interface AssetType extends AssetTypeBase {
/**
* Aspects of the asset-type. Once added aspects cannot be removed.
* @type {Array<AssetTypeAspects>}
* @memberof AssetType
*/
aspects?: Array<AssetTypeAspects>;
/**
* 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.
* @type {Array<VariableDefinition>}
* @memberof AssetType
*/
variables?: Array<VariableDefinition>;
/**
*
* @type {Array<FileAssignment>}
* @memberof AssetType
*/
fileAssignments?: Array<FileAssignment>;
}
/**
* @export
* @namespace AssetType
*/
namespace AssetType { }
/**
*
* @export
* @interface AssetTypeAspects
*/
interface 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.
* @type {string}
* @memberof AssetTypeAspects
*/
name?: string;
/**
*
* @type {AspectTypeId}
* @memberof AssetTypeAspects
*/
aspectTypeId?: AspectTypeId;
}
/**
*
* @export
* @interface AssetTypeBase
*/
interface AssetTypeBase {
/**
* The type's name.
* @type {string}
* @memberof AssetTypeBase
*/
name: string;
/**
* description
* @type {string}
* @memberof AssetTypeBase
*/
description?: string;
/**
*
* @type {AssetTypeId}
* @memberof AssetTypeBase
*/
parentTypeId?: AssetTypeId;
/**
* If instances can be created from this type. A non-instantiable type could be changed to be instantiable but not the other way around.
* @type {boolean}
* @memberof AssetTypeBase
*/
instantiable?: boolean;
/**
* 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.
* @type {string}
* @memberof AssetTypeBase
*/
scope?: AssetTypeBase.ScopeEnum;
}
/**
* @export
* @namespace AssetTypeBase
*/
namespace AssetTypeBase {
/**
* @export
* @enum {string}
*/
enum ScopeEnum {
Public,
Private
}
}
/**
* The asset type's id is a unique identifier. The id's length must be between 1 and 128 characters and matches the following symbols \"A-Z\", \"a-z\", \"0-9\", \"_\" and \".\" beginning with the tenant prefix what has a maximum of 8 characters. (e.g . ten_pref.type_id). Once set cannot be changed.
* @export
* @interface AssetTypeId
*/
interface AssetTypeId {
}
/**
*
* @export
* @interface AssetTypeLinks
*/
interface AssetTypeLinks {
/**
*
* @type {RelSelf}
* @memberof AssetTypeLinks
*/
self?: RelSelf;
/**
*
* @type {AssetTypeLinksParent}
* @memberof AssetTypeLinks
*/
parent?: AssetTypeLinksParent;
}
/**
*
* @export
* @interface AssetTypeLinksParent
*/
interface AssetTypeLinksParent {
/**
* Link to the parent asset type
* @type {string}
* @memberof AssetTypeLinksParent
*/
href?: string;
}
/**
*
* @export
* @interface AssetTypeListResource
*/
interface AssetTypeListResource {
/**
*
* @type {AssetTypeListResourceEmbedded}
* @memberof AssetTypeListResource
*/
_embedded?: AssetTypeListResourceEmbedded;
/**
*
* @type {Page}
* @memberof AssetTypeListResource
*/
page?: Page;
/**
*
* @type {PagingLinks}
* @memberof AssetTypeListResource
*/
_links?: PagingLinks;
}
/**
*
* @export
* @interface AssetTypeListResourceEmbedded
*/
interface AssetTypeListResourceEmbedded {
/**
*
* @type {Array<AssetTypeResource>}
* @memberof AssetTypeListResourceEmbedded
*/
assetTypes?: Array<AssetTypeResource>;
}
/**
*
* @export
* @interface AssetTypeResource
*/
interface AssetTypeResource extends AssetTypeBase {
/**
*
* @type {AssetTypeId}
* @memberof AssetTypeResource
*/
id?: AssetTypeId;
/**
*
* @type {TenantId}
* @memberof AssetTypeResource
*/
tenantId?: TenantId;
/**
*
* @type {ETag}
* @memberof AssetTypeResource
*/
etag?: ETag;
/**
*
* @type {Array<AssetTypeResourceAspects>}
* @memberof AssetTypeResource
*/
aspects?: Array<AssetTypeResourceAspects>;
/**
* 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.
* @type {Array<VariableDefinitionResource>}
* @memberof AssetTypeResource
*/
variables?: Array<VariableDefinitionResource>;
/**
*
* @type {Array<FileAssignmentResource>}
* @memberof AssetTypeResource
*/
fileAssignments?: Array<FileAssignmentResource>;
/**
*
* @type {AssetTypeLinks}
* @memberof AssetTypeResource
*/
_links?: AssetTypeLinks;
}
/**
* @export
* @namespace AssetTypeResource
*/
namespace AssetTypeResource { }
/**
*
* @export
* @interface AssetTypeResourceAspects
*/
interface AssetTypeResourceAspects {
/**
* Name of the aspect type, it must be unique for the asset type.
* @type {string}
* @memberof AssetTypeResourceAspects
*/
name?: string;
/**
*
* @type {any}
* @memberof AssetTypeResourceAspects
*/
aspectType?: any;
/**
*
* @type {AssetTypeResourceLinks}
* @memberof AssetTypeResourceAspects
*/
_links?: AssetTypeResourceLinks;
}
/**
*
* @export
* @interface AssetTypeResourceLinks
*/
interface AssetTypeResourceLinks {
/**
*
* @type {AssetTypeResourceLinksOrigin}
* @memberof AssetTypeResourceLinks
*/
origin?: AssetTypeResourceLinksOrigin;
}
/**
*
* @export
* @interface AssetTypeResourceLinksOrigin
*/
interface AssetTypeResourceLinksOrigin {
/**
* Link to the asset type defining the aspect. *Only visible if aspect is inherited.*
* @type {string}
* @memberof AssetTypeResourceLinksOrigin
*/
href?: string;
}
/**
*
* @export
* @interface AssetUpdate
*/
interface AssetUpdate {
/**
* Name of the asset
* @type {string}
* @memberof AssetUpdate
*/
name: string;
/**
* The id given by the user
* @type {string}
* @memberof AssetUpdate
*/
externalId?: string;
/**
* The description of the asset
* @type {string}
* @memberof AssetUpdate
*/
description?: string;
/**
*
* @type {Location}
* @memberof AssetUpdate
*/
location?: Location;
/**
*
* @type {Array<Variable>}
* @memberof AssetUpdate
*/
variables?: Array<Variable>;
/**
*
* @type {Array<Aspect>}
* @memberof AssetUpdate
*/
aspects?: Array<Aspect>;
/**
*
* @type {Array<FileAssignment>}
* @memberof AssetUpdate
*/
fileAssignments?: Array<FileAssignment>;
}
/**
*
* @export
* @interface BillboardResource
*/
interface BillboardResource {
/**
*
* @type {BillboardResourceSelf}
* @memberof BillboardResource
*/
self?: BillboardResourceSelf;
/**
*
* @type {BillboardResourceAspectTypes}
* @memberof BillboardResource
*/
aspectTypes?: BillboardResourceAspectTypes;
/**
*
* @type {BillboardResourceAssetTypes}
* @memberof BillboardResource
*/
assetTypes?: BillboardResourceAssetTypes;
/**
*
* @type {BillboardResourceAssets}
* @memberof BillboardResource
*/
assets?: BillboardResourceAssets;
/**
*
* @type {BillboardResourceFiles}
* @memberof BillboardResource
*/
files?: BillboardResourceFiles;
}
/**
*
* @export
* @interface BillboardResourceAspectTypes
*/
interface BillboardResourceAspectTypes {
/**
* Link to aspect-types resource
* @type {string}
* @memberof BillboardResourceAspectTypes
*/
href?: string;
}
/**
*
* @export
* @interface BillboardResourceAssetTypes
*/
interface BillboardResourceAssetTypes {
/**
* Link to asset-types resource
* @type {string}
* @memberof BillboardResourceAssetTypes
*/
href?: string;
}
/**
*
* @export
* @interface BillboardResourceAssets
*/
interface BillboardResourceAssets {
/**
* Link to assets resource
* @type {string}
* @memberof BillboardResourceAssets
*/
href?: string;
}
/**
*
* @export
* @interface BillboardResourceFiles
*/
interface BillboardResourceFiles {
/**
* Link to files resource
* @type {string}
* @memberof BillboardResourceFiles
*/
href?: string;
}
/**
*
* @export
* @interface BillboardResourceSelf
*/
interface BillboardResourceSelf {
/**
* Link to the billboard url
* @type {string}
* @memberof BillboardResourceSelf
*/
href?: string;
}
/**
* incremental counter for optimistic locking
* ! fix: manually converted ETag interface to string.
* @export
* @interface ETag
*/
type ETag = string;
/**
*
* @export
* @interface Errors
*/
interface Errors extends Array<ErrorsInner> {
}
/**
*
* @export
* @interface ErrorsInner
*/
interface ErrorsInner {
/**
*
* @type {number}
* @memberof ErrorsInner
*/
errorcode?: number;
/**
*
* @type {string}
* @memberof ErrorsInner
*/
logref?: string;
/**
*
* @type {string}
* @memberof ErrorsInner
*/
message?: string;
}
/**
*
* @export
* @interface FileAssignment
*/
interface FileAssignment {
/**
* Keyword for the file to be assigned to an asset.
* @type {string}
* @memberof FileAssignment
*/
key?: string;
/**
* The id of the file to be assigned
* @type {string}
* @memberof FileAssignment
*/
fileId?: string;
}
/**
*
* @export
* @interface FileAssignmentLinks
*/
interface FileAssignmentLinks {
/**
*
* @type {FileAssignmentLinksDownload}
* @memberof FileAssignmentLinks
*/
download?: FileAssignmentLinksDownload;
/**
*
* @type {FileAssignmentLinksMetadata}
* @memberof FileAssignmentLinks
*/
metadata?: FileAssignmentLinksMetadata;
/**
*
* @type {FileAssignmentLinksOrigin}
* @memberof FileAssignmentLinks
*/
origin?: FileAssignmentLinksOrigin;
}
/**
*
* @export
* @interface FileAssignmentLinksDownload
*/
interface FileAssignmentLinksDownload {
/**
* Link to download the file
* @type {string}
* @memberof FileAssignmentLinksDownload
*/
href?: string;
}
/**
*
* @export
* @interface FileAssignmentLinksMetadata
*/
interface FileAssignmentLinksMetadata {
/**
* Link to get metadata of the file
* @type {string}
* @memberof FileAssignmentLinksMetadata
*/
href?: string;
}
/**
*
* @export
* @interface FileAssignmentLinksOrigin
*/
interface FileAssignmentLinksOrigin {
/**
* Link to access the file assignment. Only visible if assignment is inherited
* @type {string}
* @memberof FileAssignmentLinksOrigin
*/
href?: string;
}
/**
*
* @export
* @interface FileAssignmentResource
*/
interface FileAssignmentResource extends FileAssignment {
/**
*
* @type {FileAssignmentLinks}
* @memberof FileAssignmentResource
*/
_links?: FileAssignmentLinks;
}
/**
*
* @export
* @interface FileMetadataListResource
*/
interface FileMetadataListResource {
/**
*
* @type {FileMetadataListResourceEmbedded}
* @memberof FileMetadataListResource
*/
_embedded?: FileMetadataListResourceEmbedded;
/**
*
* @type {Page}
* @memberof FileMetadataListResource
*/
page?: Page;
/**
*
* @type {PagingLinks}
* @memberof FileMetadataListResource
*/
_links?: PagingLinks;
}
/**
*
* @export
* @interface FileMetadataListResourceEmbedded
*/
interface FileMetadataListResourceEmbedded {
/**
*
* @type {Array<FileMetadataResource>}
* @memberof FileMetadataListResourceEmbedded
*/
files?: Array<FileMetadataResource>;
}
/**
*
* @export
* @interface FileMetadataResource
*/
interface FileMetadataResource {
/**
*
* @type {UniqueId}
* @memberof FileMetadataResource
*/
id?: UniqueId;
/**
* File name given by the user
* @type {string}
* @memberof FileMetadataResource
*/
name?: string;
/**
* Original filename of the file
* @type {string}
* @memberof FileMetadataResource
*/
originalFileName?: string;
/**
* File description
* @type {string}
* @memberof FileMetadataResource
*/
description?: string;
/**
*
* @type {TenantId}
* @memberof FileMetadataResource
*/
tenantId?: TenantId;
/**
* The id of the end-customer
* @type {string}
* @memberof FileMetadataResource
*/
subTenant?: string;
/**
* The time of the file upload
* @type {Date}
* @memberof FileMetadataResource
*/
uploaded?: Date;
/**
* The time of the latest modification of the file
* @type {Date}
* @memberof FileMetadataResource
*/
lastModified?: Date;
/**
* Is the file used in any file assignment
* @type {boolean}
* @memberof FileMetadataResource
*/
isAssigned?: boolean;
/**
* 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.
* @type {string}
* @memberof FileMetadataResource
*/
scope?: FileMetadataResource.ScopeEnum;
/**
*
* @type {ETag}
* @memberof FileMetadataResource
*/
etag?: ETag;
/**
*
* @type {FileMetadataResourceLinks}
* @memberof FileMetadataResource
*/
_links?: FileMetadataResourceLinks;
}
/**
* @export
* @namespace FileMetadataResource
*/
namespace FileMetadataResource {
/**
* @export
* @enum {string}
*/
enum ScopeEnum {
PUBLIC,
PRIVATE
}
}
/**
*
* @export
* @interface FileMetadataResourceLinks
*/
interface FileMetadataResourceLinks {
/**
*
* @type {RelSelf}
* @memberof FileMetadataResourceLinks
*/
self?: RelSelf;
/**
*
* @type {LinkForDownloadingTheFile}
* @memberof FileMetadataResourceLinks
*/
download?: LinkForDownloadingTheFile;
}
/**
*
* @export
* @interface KeyedFileAssignment
*/
interface KeyedFileAssignment {
/**
* The id of the file to be assigned
* @type {string}
* @memberof KeyedFileAssignment
*/
fileId?: string;
}
/**
*
* @export
* @interface LinkForDownloadingTheFile
*/
interface LinkForDownloadingTheFile {
/**
*
* @type {string}
* @memberof LinkForDownloadingTheFile
*/
href?: string;
}
/**
*
* @export
* @interface Location
*/
interface Location {
/**
*
* @type {string}
* @memberof Location
*/
country?: string;
/**
* County or other region code or name
* @type {string}
* @memberof Location
*/
region?: string;
/**
*
* @type {string}
* @memberof Location
*/
locality?: string;
/**
*
* @type {string}
* @memberof Location
*/
streetAddress?: string;
/**
*
* @type {string}
* @memberof Location
*/
postalCode?: string;
/**
* The longitude part of the geographic coordinates
* @type {number}
* @memberof Location
*/
longitude?: number;
/**
* The latitude part of the geographic coordinates
* @type {number}
* @memberof Location
*/
latitude?: number;
}
/**
*
* @export
* @interface LockResource
*/
interface LockResource {
/**
*
* @type {UniqueId}
* @memberof LockResource
*/
id?: UniqueId;
/**
* Service creating the lock
* @type {string}
* @memberof LockResource
*/
service?: string;
/**
* Reason of lock
* @type {string}
* @memberof LockResource
*/
reason?: string;
/**
* Code of the reason
* @type {string}
* @memberof LockResource
*/
reasonCode?: string;
/**
*
* @type {LockResourceLinks}
* @memberof LockResource
*/
_links?: LockResourceLinks;
}
/**
*
* @export
* @interface LockResourceLinks
*/
interface LockResourceLinks {
/**
*
* @type {RelSelf}
* @memberof LockResourceLinks
*/
self?: RelSelf;
}
/**
*
* @export
* @interface Page
*/
interface Page {
/**
*
* @type {number}
* @memberof Page
*/
size?: number;
/**
*
* @type {number}
* @memberof Page
*/
totalElements?: number;
/**
*
* @type {number}
* @memberof Page
*/
totalPages?: number;
/**
*
* @type {number}
* @memberof Page
*/
number?: number;
}
/**
*
* @export
* @interface PagingLinks
*/
interface PagingLinks {
/**
*
* @type {RelSelf}
* @memberof PagingLinks
*/
self?: RelSelf;
/**
*
* @type {LinkForDownloadingTheFile}
* @memberof PagingLinks
*/
first?: LinkForDownloadingTheFile;
/**
*
* @type {LinkForDownloadingTheFile}
* @memberof PagingLinks
*/
prev?: LinkForDownloadingTheFile;
/**
*
* @type {LinkForDownloadingTheFile}
* @memberof PagingLinks
*/
next?: LinkForDownloadingTheFile;
/**
*
* @type {LinkForDownloadingTheFile}
* @memberof PagingLinks
*/
last?: LinkForDownloadingTheFile;
}
/**
*
* @export
* @interface RelSelf
*/
interface RelSelf {
/**
*
* @type {string}
* @memberof RelSelf
*/
href?: string;
}
/**
*
* @export
* @interface RootAssetResource
*/
interface RootAssetResource extends AssetResource {
/**
* Hieararchy path is empty for the root asset
* @type {Array<string>}
* @memberof RootAssetResource
*/
hierarchyPath?: Array<string>;
}
/**
* @export
* @namespace RootAssetResource
*/
namespace RootAssetResource { }
/**
* The unique identifier of the tenant
* @export
* @interface TenantId
*/
interface TenantId {
}
/**
* The timezone to be used for timeseries aggregation. By default it is inherited from the tenant's defaultTimezone, but can be overwritten. The timezone value should be set to a Java time zone ID such as \"America/LosAngeles\" or \"Etc/GMT+2\". Time zones that 15 or 45 minutes off a UTC hour are not supported, such as Nepal standard time (UTC+05:45). Time zones that are 30 minutes off a UTC hour are supported, such as India (UTC+05:30).
* @export
* @interface Timezone
*/
interface Timezone {
}
/**
* Indicates that the asset is a real asset (performance) or for simulation. If omitted on creation then it defaults to performance. Setting the twinType to simulation allows high resolution timestamps (microsecond precision).
* @export
* @enum {string}
*/
enum TwinType {
Performance,
Simulation
}
/**
*
* @export
* @interface UniqueId
*/
type UniqueId = string;
/**
*
* @export
* @interface Variable
*/
interface Variable {
/**
*
* @type {string}
* @memberof Variable
*/
name?: string;
/**
*
* @type {string}
* @memberof Variable
*/
value?: string;
}
/**
*
* @export
* @interface VariableDefinition
*/
interface 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.
* @type {string}
* @memberof VariableDefinition
*/
name: string;
/**
* Data type of the variable. BIG_STRING could only be used by variables in dynamic aspect-types. Cannot be changed.
* @type {string}
* @memberof VariableDefinition
*/
dataType: VariableDefinition.DataTypeEnum;
/**
* Unit of measurement. Cannot be changed.
* @type {string}
* @memberof VariableDefinition
*/
unit?: string;
/**
* Indicates whether sorting and filtering is allowed on this variable. Only usable for static properties. Cannot be changed.
* @type {boolean}
* @memberof VariableDefinition
*/
searchable?: boolean;
/**
* 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.
* @type {number}
* @memberof VariableDefinition
*/
length?: number;
/**
* 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.
* @type {string}
* @memberof VariableDefinition
*/
defaultValue?: string;
}
/**
* @export
* @namespace VariableDefinition
*/
namespace VariableDefinition {
/**
* @export
* @enum {string}
*/
enum DataTypeEnum {
BOOLEAN,
INT,
LONG,
DOUBLE,
STRING,
TIMESTAMP,
BIGSTRING
}
}
/**
*
* @export
* @interface VariableDefinitionResource
*/
interface VariableDefinitionResource extends VariableDefinition {
/**
*
* @type {VariableDefinitionResourceLinks}
* @memberof VariableDefinitionResource
*/
_links?: VariableDefinitionResourceLinks;
}
/**
* @export
* @namespace VariableDefinitionResource
*/
namespace VariableDefinitionResource { }
/**
*
* @export
* @interface VariableDefinitionResourceLinks
*/
interface VariableDefinitionResourceLinks {
/**
*
* @type {VariableDefinitionResourceLinksOrigin}
* @memberof VariableDefinitionResourceLinks
*/
origin?: VariableDefinitionResourceLinksOrigin;
}
/**
* Link to the asset type defining the variable. *Only visible if variable is inherited.*
* @export
* @interface VariableDefinitionResourceLinksOrigin
*/
interface VariableDefinitionResourceLinksOrigin {
/**
*
* @type {string}
* @memberof VariableDefinitionResourceLinksOrigin
*/
href?: string;
}
/**
*
* @export
* @interface VariableListResource
*/
interface VariableListResource {
/**
*
* @type {VariableListResourceEmbedded}
* @memberof VariableListResource
*/
_embedded?: VariableListResourceEmbedded;
/**
*
* @type {Page}
* @memberof VariableListResource
*/
page?: Page;
/**
*
* @type {PagingLinks}
* @memberof VariableListResource
*/
_links?: PagingLinks;
}
/**
*
* @export
* @interface VariableListResourceEmbedded
*/
interface VariableListResourceEmbedded {
/**
*
* @type {Array<VariableDefinition>}
* @memberof VariableListResourceEmbedded
*/
variables?: Array<VariableDefinition>;
}
}