Namespace Kepware.Api.Model
Classes
- ApiCallFailedException
Exception thrown when an API call fails.
- ApiResult
Represents the result of an API call.
- ApiStatus
Represents the status of the Configuration API REST service.
- ApplyFailure
Represents one failed apply operation and the attempted item.
- BaseEntity
Abstract base class for all entities in the Kepware API.
- Channel
Represents a channel in the project.
- ChannelCollection
Represents the collection of channels in a project
- CollectionApplyResult<K>
Represents detailed compare-and-apply results for a collection.
- ConsumerExchangeCollection
Represents the collection of consumer exchanges in a consumer exchange group
- ConsumerExchangeGroupCollection
Represents the collection of consumer exchange groups in a device
- DefaultEntity
A default entity with an optional owner.
- Device
Represents a device in a channel.
- DeviceCollection
Represents the collection of devices in a channel
- DeviceProfileCollection
Represents the collection of deviceprofiles in a device
- DeviceTagCollection
Represents the collection of tags in a device
- DeviceTagGroup
Represents a tag group in a device
- DeviceTagGroupCollection
Represents the collection of tag groups in a device or tag group
- Docs
Contains classes and definitions for API documentation.
- Docs.Channel
Represents a channel in the API documentation.
- Docs.CollectionDefinition
Represents a collection definition in the API documentation.
- Docs.Device
Represents a device in the API documentation.
- Docs.Driver
Represents a driver in the API documentation.
- Docs.PropertyDefinition
Represents a property definition in the API documentation.
- Docs.TypeDefinition
Represents a type definition in the API documentation.
- IotAgent
Base class for all IoT Gateway agent types. Contains the universal properties shared by MQTT Client, REST Client, and REST Server agents.
- IotGatewayContainer
Container class representing the
_iot_gatewaynode in the full project JSON. Holds the three agent collections (MQTT Client, REST Client, REST Server).
- IotItem
Represents an IoT Item in the IoT Gateway. IoT Items are children of agent types and identify the data objects exposed by the agent.
- IotItemCollection
Represents the collection of IoT Items in an IoT Gateway agent.
- MqttClientAgent
Represents an MQTT Client agent in the IoT Gateway.
- MqttClientAgentCollection
Represents the collection of MQTT Client agents in the IoT Gateway.
- NamedEntity
A named entity with a unique name and description.
- NamedUidEntity
A named entity with a unique identifier.
- OmniAlarmCollection
Represents the collection of omni gas alarms in an omni mapping
- OmniMappingCollection
Represents the collection of omni mappings in an omni mapping group
- OmniMappingGroupCollection
Represents the collection of omni mapping groups in a device
- PhoneEntryCollection
Represents the collection of phone entries in a phonebook
- PhonebookCollection
Represents the collection of phonebooks in a channel
- ProducerExchangeCollection
Represents the collection of producer exchanges in a producer exchange group
- ProducerExchangeGroupCollection
Represents the collection of producer exchange groups in a device
- ProductInfo
Represents information about a product.
- Project
Represents a project in the Kepware configuration. It provides the project properties for the client interfaces that Kepware supports.
- ProjectCompareAndApplyResult
Represents detailed compare-and-apply results for a full project operation.
- ProjectProperties
Represents the project properties in the Kepware configuration
- ProjectPropertiesJsonConverter
Custom converter to support both flat and nested (client_interfaces) project property formats.
- Properties
Contains constants related to OPC UA Endpoints in Kepware API.
- Properties.AdminSettings.CommDiagnostics
Contains constants related to communication diagnostics.
- Properties.AdminSettings.ConfigApi
Contains constants related to Configuration API diagnostics.
- Properties.AdminSettings.EventLog
Contains constants related to event log settings.
- Properties.AdminSettings.Licensing
Contains constants related to licensing settings.
- Properties.AdminSettings.OpcDiagnostics
Contains constants related to OPC diagnostics.
- Properties.IotAgent
Property key constants shared by all IoT Gateway agent types.
- Properties.IotItem
Property key constants for IoT Items.
- Properties.MqttClientAgent
Property key constants specific to MQTT Client agents.
- Properties.NonSerialized
Contains constants related to non-serialized properties.
- Properties.NonUpdatable
Contains constants related to non-updatable properties.
- Properties.ProjectSettings.Dde
Contains constants related to DDE server properties.
- Properties.ProjectSettings.FastDdeSuiteLink
Contains constants related to FastDDE/SuiteLink server properties.
- Properties.ProjectSettings.OpcDa
Contains constants related to OPC DA server properties.
- Properties.ProjectSettings.OpcHda
Contains constants related to OPC HDA server properties.
- Properties.ProjectSettings.OpcUa
Contains constants related to OPC UA server properties.
- Properties.RestClientAgent
Property key constants specific to REST Client agents.
- Properties.RestServerAgent
Property key constants specific to REST Server agents.
- Properties.Tag
Contains constants related to tag properties.
- PublishingIotAgent
Base class for IoT Gateway agent types that support publishing (MQTT Client and REST Client). Contains publish configuration and message template properties not applicable to REST Server agents.
- RestClientAgent
Represents a REST Client agent in the IoT Gateway.
- RestClientAgentCollection
Represents the collection of REST Client agents in the IoT Gateway.
- RestServerAgent
Represents a REST Server agent in the IoT Gateway. REST Server agents do not have publish or message template properties.
- RestServerAgentCollection
Represents the collection of REST Server agents in the IoT Gateway.
- Tag
Represents a tag in a device or tag group.
- UpdateApiResponseMessage
Represents the response from an update endpoint that may include partially applied properties.
Structs
- ApiResponse<T>
Represents a structured response from an API call, encapsulating a response code, an optional message, an optional value, and the endpoint reference.
Interfaces
- IHaveName
Interface for entities that have a name.
- IHaveOwner
Interface for entities that have an owner.
Enums
- ApiResponseCode
Represents API response codes according to HTTP standards.
- ApplyOperation
Represents the type of operation applied during compare-and-apply.
- IotItemDataType
Specifies the data type for IoT Items.
- IotMessageFormat
Specifies the message format for IoT Gateway agents.
- IotPublishFormat
Specifies the publish format for IoT Gateway agents.
- IotPublishType
Specifies the publish type for IoT Gateway agents.
- MqttQos
Specifies the MQTT Quality of Service level.
- MqttTlsVersion
Specifies the TLS version for MQTT secure connections.
- ProductType
Represents the type of product.
- RestClientHttpMethod
Specifies the HTTP method for REST Client agents.
- RestClientMediaType
Specifies the content-type header for REST Client agent publish.
- ThingWorxDataStoreMaxSize
The maximum size of the datastore in which to store updates when offline. Changing this property causes the interface to restart and deletes the current datastore.
- ThingWorxForwardMode
Specify the Forward Mode to control which updates are sent to the platform upon reconnect.
- ThingwWorxLoggingLevel
Defines the ThingWorx native interface logging level modes. Determines that amount of information logged. Set to Trace to generate the most detailed output.