{"id":19988335,"url":"https://github.com/opcfoundation/opcua-webapi-python","last_synced_at":"2025-03-01T21:23:20.692Z","repository":{"id":261188804,"uuid":"865205199","full_name":"OPCFoundation/opcua-webapi-python","owner":"OPCFoundation","description":null,"archived":false,"fork":false,"pushed_at":"2025-02-08T04:37:54.000Z","size":823,"stargazers_count":2,"open_issues_count":0,"forks_count":2,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-02-21T10:36:45.274Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/OPCFoundation.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":"docs/SecurityGroupDataType.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-09-30T06:49:41.000Z","updated_at":"2025-02-13T19:27:15.000Z","dependencies_parsed_at":"2024-12-04T10:33:06.340Z","dependency_job_id":null,"html_url":"https://github.com/OPCFoundation/opcua-webapi-python","commit_stats":null,"previous_names":["opcfoundation/opcua-webapi-python"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/OPCFoundation%2Fopcua-webapi-python","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/OPCFoundation%2Fopcua-webapi-python/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/OPCFoundation%2Fopcua-webapi-python/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/OPCFoundation%2Fopcua-webapi-python/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/OPCFoundation","download_url":"https://codeload.github.com/OPCFoundation/opcua-webapi-python/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":241426372,"owners_count":19961022,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-13T04:42:47.209Z","updated_at":"2025-03-01T21:23:20.684Z","avatar_url":"https://github.com/OPCFoundation.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# opcua-webapi\nProvides simple HTTPS based access to an OPC UA server.\n\nThis Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:\n\n- API version: 1.05.4\n- Package version: 1.504.1\n- Generator version: 7.9.0\n- Build package: org.openapitools.codegen.languages.PythonClientCodegen\n\n## Requirements.\n\nPython 3.7+\n\n## Installation \u0026 Usage\n### pip install\n\nIf the python package is hosted on a repository, you can install directly using:\n\n```sh\npip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git\n```\n(you may need to run `pip` with root permission: `sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git`)\n\nThen import the package:\n```python\nimport opcua_webapi\n```\n\n### Setuptools\n\nInstall via [Setuptools](http://pypi.python.org/pypi/setuptools).\n\n```sh\npython setup.py install --user\n```\n(or `sudo python setup.py install` to install the package for all users)\n\nThen import the package:\n```python\nimport opcua_webapi\n```\n\n### Tests\n\nExecute `pytest` to run the tests.\n\n## Getting Started\n\nPlease follow the [installation procedure](#installation--usage) and then run the following:\n\n```python\n\nimport opcua_webapi\nfrom opcua_webapi.rest import ApiException\nfrom pprint import pprint\n\n# Defining the host is optional and defaults to http://localhost:4840\n# See configuration.py for a list of all supported configuration parameters.\nconfiguration = opcua_webapi.Configuration(\n    host = \"http://localhost:4840\"\n)\n\n\n\n# Enter a context with an instance of the API client\nwith opcua_webapi.ApiClient(configuration) as api_client:\n    # Create an instance of the API class\n    api_instance = opcua_webapi.DefaultApi(api_client)\n    activate_session_request = opcua_webapi.ActivateSessionRequest() # ActivateSessionRequest | [Link to specification](https://reference.opcfoundation.org/v105/Core/docs/Part4/5.7.3/#5.7.3.2). (optional)\n\n    try:\n        api_response = api_instance.activate_session(activate_session_request=activate_session_request)\n        print(\"The response of DefaultApi-\u003eactivate_session:\\n\")\n        pprint(api_response)\n    except ApiException as e:\n        print(\"Exception when calling DefaultApi-\u003eactivate_session: %s\\n\" % e)\n\n```\n\n## Documentation for API Endpoints\n\nAll URIs are relative to *http://localhost:4840*\n\nClass | Method | HTTP request | Description\n------------ | ------------- | ------------- | -------------\n*DefaultApi* | [**activate_session**](docs/DefaultApi.md#activate_session) | **POST** /activatesession | \n*DefaultApi* | [**browse**](docs/DefaultApi.md#browse) | **POST** /browse | \n*DefaultApi* | [**browse_next**](docs/DefaultApi.md#browse_next) | **POST** /browsenext | \n*DefaultApi* | [**call**](docs/DefaultApi.md#call) | **POST** /call | \n*DefaultApi* | [**cancel**](docs/DefaultApi.md#cancel) | **POST** /cancel | \n*DefaultApi* | [**close_session**](docs/DefaultApi.md#close_session) | **POST** /closesession | \n*DefaultApi* | [**create_monitored_items**](docs/DefaultApi.md#create_monitored_items) | **POST** /createmonitoreditems | \n*DefaultApi* | [**create_session**](docs/DefaultApi.md#create_session) | **POST** /createsession | \n*DefaultApi* | [**create_subscription**](docs/DefaultApi.md#create_subscription) | **POST** /createsubscription | \n*DefaultApi* | [**delete_monitored_items**](docs/DefaultApi.md#delete_monitored_items) | **POST** /deletemonitoreditems | \n*DefaultApi* | [**delete_subscriptions**](docs/DefaultApi.md#delete_subscriptions) | **POST** /deletesubscriptions | \n*DefaultApi* | [**find_servers**](docs/DefaultApi.md#find_servers) | **POST** /findservers | \n*DefaultApi* | [**get_endpoints**](docs/DefaultApi.md#get_endpoints) | **POST** /getendpoints | \n*DefaultApi* | [**history_read**](docs/DefaultApi.md#history_read) | **POST** /historyread | \n*DefaultApi* | [**history_update**](docs/DefaultApi.md#history_update) | **POST** /historyupdate | \n*DefaultApi* | [**modify_monitored_items**](docs/DefaultApi.md#modify_monitored_items) | **POST** /modifymonitoreditems | \n*DefaultApi* | [**modify_subscription**](docs/DefaultApi.md#modify_subscription) | **POST** /modifysubscription | \n*DefaultApi* | [**publish**](docs/DefaultApi.md#publish) | **POST** /publish | \n*DefaultApi* | [**read**](docs/DefaultApi.md#read) | **POST** /read | \n*DefaultApi* | [**register_nodes**](docs/DefaultApi.md#register_nodes) | **POST** /registernodes | \n*DefaultApi* | [**republish**](docs/DefaultApi.md#republish) | **POST** /republish | \n*DefaultApi* | [**set_monitoring_mode**](docs/DefaultApi.md#set_monitoring_mode) | **POST** /setmonitoringmode | \n*DefaultApi* | [**set_publishing_mode**](docs/DefaultApi.md#set_publishing_mode) | **POST** /setpublishingmode | \n*DefaultApi* | [**set_triggering**](docs/DefaultApi.md#set_triggering) | **POST** /settriggering | \n*DefaultApi* | [**transfer_subscriptions**](docs/DefaultApi.md#transfer_subscriptions) | **POST** /transfersubscriptions | \n*DefaultApi* | [**translate_browse_paths_to_node_ids**](docs/DefaultApi.md#translate_browse_paths_to_node_ids) | **POST** /translate | \n*DefaultApi* | [**unregister_nodes**](docs/DefaultApi.md#unregister_nodes) | **POST** /unregisternodes | \n*DefaultApi* | [**write**](docs/DefaultApi.md#write) | **POST** /write | \n\n\n## Documentation For Models\n\n - [ActionMethodDataType](docs/ActionMethodDataType.md)\n - [ActionState](docs/ActionState.md)\n - [ActionTargetDataType](docs/ActionTargetDataType.md)\n - [ActivateSessionRequest](docs/ActivateSessionRequest.md)\n - [ActivateSessionResponse](docs/ActivateSessionResponse.md)\n - [AggregateConfiguration](docs/AggregateConfiguration.md)\n - [AggregateFilter](docs/AggregateFilter.md)\n - [AggregateFilterResult](docs/AggregateFilterResult.md)\n - [ApplicationDescription](docs/ApplicationDescription.md)\n - [ApplicationType](docs/ApplicationType.md)\n - [Argument](docs/Argument.md)\n - [AttributeOperand](docs/AttributeOperand.md)\n - [BrokerConnectionTransportDataType](docs/BrokerConnectionTransportDataType.md)\n - [BrokerDataSetReaderTransportDataType](docs/BrokerDataSetReaderTransportDataType.md)\n - [BrokerDataSetWriterTransportDataType](docs/BrokerDataSetWriterTransportDataType.md)\n - [BrokerTransportQualityOfService](docs/BrokerTransportQualityOfService.md)\n - [BrokerWriterGroupTransportDataType](docs/BrokerWriterGroupTransportDataType.md)\n - [BrowseDescription](docs/BrowseDescription.md)\n - [BrowseDirection](docs/BrowseDirection.md)\n - [BrowseNextRequest](docs/BrowseNextRequest.md)\n - [BrowseNextResponse](docs/BrowseNextResponse.md)\n - [BrowsePath](docs/BrowsePath.md)\n - [BrowsePathResult](docs/BrowsePathResult.md)\n - [BrowsePathTarget](docs/BrowsePathTarget.md)\n - [BrowseRequest](docs/BrowseRequest.md)\n - [BrowseResponse](docs/BrowseResponse.md)\n - [BrowseResult](docs/BrowseResult.md)\n - [CallMethodRequest](docs/CallMethodRequest.md)\n - [CallMethodResult](docs/CallMethodResult.md)\n - [CallRequest](docs/CallRequest.md)\n - [CallResponse](docs/CallResponse.md)\n - [CancelRequest](docs/CancelRequest.md)\n - [CancelResponse](docs/CancelResponse.md)\n - [CloseSessionRequest](docs/CloseSessionRequest.md)\n - [CloseSessionResponse](docs/CloseSessionResponse.md)\n - [ConfigurationVersionDataType](docs/ConfigurationVersionDataType.md)\n - [ContentFilter](docs/ContentFilter.md)\n - [ContentFilterElement](docs/ContentFilterElement.md)\n - [ContentFilterElementResult](docs/ContentFilterElementResult.md)\n - [ContentFilterResult](docs/ContentFilterResult.md)\n - [CreateMonitoredItemsRequest](docs/CreateMonitoredItemsRequest.md)\n - [CreateMonitoredItemsResponse](docs/CreateMonitoredItemsResponse.md)\n - [CreateSessionRequest](docs/CreateSessionRequest.md)\n - [CreateSessionResponse](docs/CreateSessionResponse.md)\n - [CreateSubscriptionRequest](docs/CreateSubscriptionRequest.md)\n - [CreateSubscriptionResponse](docs/CreateSubscriptionResponse.md)\n - [DataChangeFilter](docs/DataChangeFilter.md)\n - [DataChangeNotification](docs/DataChangeNotification.md)\n - [DataChangeTrigger](docs/DataChangeTrigger.md)\n - [DataSetFieldContentMaskBits](docs/DataSetFieldContentMaskBits.md)\n - [DataSetFieldFlagsBits](docs/DataSetFieldFlagsBits.md)\n - [DataSetMetaDataType](docs/DataSetMetaDataType.md)\n - [DataSetReaderDataType](docs/DataSetReaderDataType.md)\n - [DataSetWriterDataType](docs/DataSetWriterDataType.md)\n - [DataTypeDescription](docs/DataTypeDescription.md)\n - [DataTypeSchemaHeader](docs/DataTypeSchemaHeader.md)\n - [DataValue](docs/DataValue.md)\n - [Decimal](docs/Decimal.md)\n - [DeleteMonitoredItemsRequest](docs/DeleteMonitoredItemsRequest.md)\n - [DeleteMonitoredItemsResponse](docs/DeleteMonitoredItemsResponse.md)\n - [DeleteSubscriptionsRequest](docs/DeleteSubscriptionsRequest.md)\n - [DeleteSubscriptionsResponse](docs/DeleteSubscriptionsResponse.md)\n - [DiagnosticInfo](docs/DiagnosticInfo.md)\n - [EUInformation](docs/EUInformation.md)\n - [ElementOperand](docs/ElementOperand.md)\n - [EndpointDescription](docs/EndpointDescription.md)\n - [EnumDefinition](docs/EnumDefinition.md)\n - [EnumDescription](docs/EnumDescription.md)\n - [EnumField](docs/EnumField.md)\n - [EnumValueType](docs/EnumValueType.md)\n - [EventFieldList](docs/EventFieldList.md)\n - [EventFilter](docs/EventFilter.md)\n - [EventFilterResult](docs/EventFilterResult.md)\n - [EventNotificationList](docs/EventNotificationList.md)\n - [ExtensionObject](docs/ExtensionObject.md)\n - [FieldMetaData](docs/FieldMetaData.md)\n - [FilterOperator](docs/FilterOperator.md)\n - [FindServersRequest](docs/FindServersRequest.md)\n - [FindServersResponse](docs/FindServersResponse.md)\n - [GetEndpointsRequest](docs/GetEndpointsRequest.md)\n - [GetEndpointsResponse](docs/GetEndpointsResponse.md)\n - [HistoryData](docs/HistoryData.md)\n - [HistoryEvent](docs/HistoryEvent.md)\n - [HistoryEventFieldList](docs/HistoryEventFieldList.md)\n - [HistoryModifiedData](docs/HistoryModifiedData.md)\n - [HistoryReadRequest](docs/HistoryReadRequest.md)\n - [HistoryReadResponse](docs/HistoryReadResponse.md)\n - [HistoryReadResult](docs/HistoryReadResult.md)\n - [HistoryReadValueId](docs/HistoryReadValueId.md)\n - [HistoryUpdateRequest](docs/HistoryUpdateRequest.md)\n - [HistoryUpdateResponse](docs/HistoryUpdateResponse.md)\n - [HistoryUpdateResult](docs/HistoryUpdateResult.md)\n - [HistoryUpdateType](docs/HistoryUpdateType.md)\n - [IssuedIdentityToken](docs/IssuedIdentityToken.md)\n - [JsonActionMetaDataMessage](docs/JsonActionMetaDataMessage.md)\n - [JsonActionNetworkMessage](docs/JsonActionNetworkMessage.md)\n - [JsonActionRequestMessage](docs/JsonActionRequestMessage.md)\n - [JsonActionResponderMessage](docs/JsonActionResponderMessage.md)\n - [JsonActionResponseMessage](docs/JsonActionResponseMessage.md)\n - [JsonApplicationDescriptionMessage](docs/JsonApplicationDescriptionMessage.md)\n - [JsonDataSetMessage](docs/JsonDataSetMessage.md)\n - [JsonDataSetMessageContentMaskBits](docs/JsonDataSetMessageContentMaskBits.md)\n - [JsonDataSetMetaDataMessage](docs/JsonDataSetMetaDataMessage.md)\n - [JsonDataSetReaderMessageDataType](docs/JsonDataSetReaderMessageDataType.md)\n - [JsonDataSetWriterMessageDataType](docs/JsonDataSetWriterMessageDataType.md)\n - [JsonMessageType](docs/JsonMessageType.md)\n - [JsonNetworkMessage](docs/JsonNetworkMessage.md)\n - [JsonNetworkMessageContentMaskBits](docs/JsonNetworkMessageContentMaskBits.md)\n - [JsonPubSubConnectionMessage](docs/JsonPubSubConnectionMessage.md)\n - [JsonServerEndpointsMessage](docs/JsonServerEndpointsMessage.md)\n - [JsonStatusMessage](docs/JsonStatusMessage.md)\n - [JsonWriterGroupMessageDataType](docs/JsonWriterGroupMessageDataType.md)\n - [KeyValuePair](docs/KeyValuePair.md)\n - [LiteralOperand](docs/LiteralOperand.md)\n - [LocalizedText](docs/LocalizedText.md)\n - [Matrix](docs/Matrix.md)\n - [MessageSecurityMode](docs/MessageSecurityMode.md)\n - [ModificationInfo](docs/ModificationInfo.md)\n - [ModifyMonitoredItemsRequest](docs/ModifyMonitoredItemsRequest.md)\n - [ModifyMonitoredItemsResponse](docs/ModifyMonitoredItemsResponse.md)\n - [ModifySubscriptionRequest](docs/ModifySubscriptionRequest.md)\n - [ModifySubscriptionResponse](docs/ModifySubscriptionResponse.md)\n - [MonitoredItemCreateRequest](docs/MonitoredItemCreateRequest.md)\n - [MonitoredItemCreateResult](docs/MonitoredItemCreateResult.md)\n - [MonitoredItemModifyRequest](docs/MonitoredItemModifyRequest.md)\n - [MonitoredItemModifyResult](docs/MonitoredItemModifyResult.md)\n - [MonitoredItemNotification](docs/MonitoredItemNotification.md)\n - [MonitoringMode](docs/MonitoringMode.md)\n - [MonitoringParameters](docs/MonitoringParameters.md)\n - [NetworkAddressDataType](docs/NetworkAddressDataType.md)\n - [NodeClass](docs/NodeClass.md)\n - [NotificationMessage](docs/NotificationMessage.md)\n - [PerformUpdateType](docs/PerformUpdateType.md)\n - [PermissionTypeBits](docs/PermissionTypeBits.md)\n - [PubSubConfiguration2DataType](docs/PubSubConfiguration2DataType.md)\n - [PubSubConfigurationDataType](docs/PubSubConfigurationDataType.md)\n - [PubSubConnectionDataType](docs/PubSubConnectionDataType.md)\n - [PubSubGroupDataType](docs/PubSubGroupDataType.md)\n - [PubSubKeyPushTargetDataType](docs/PubSubKeyPushTargetDataType.md)\n - [PubSubState](docs/PubSubState.md)\n - [PublishRequest](docs/PublishRequest.md)\n - [PublishResponse](docs/PublishResponse.md)\n - [PublishedDataSetDataType](docs/PublishedDataSetDataType.md)\n - [Range](docs/Range.md)\n - [ReadAnnotationDataDetails](docs/ReadAnnotationDataDetails.md)\n - [ReadAtTimeDetails](docs/ReadAtTimeDetails.md)\n - [ReadEventDetails](docs/ReadEventDetails.md)\n - [ReadEventDetails2](docs/ReadEventDetails2.md)\n - [ReadProcessedDetails](docs/ReadProcessedDetails.md)\n - [ReadRawModifiedDetails](docs/ReadRawModifiedDetails.md)\n - [ReadRequest](docs/ReadRequest.md)\n - [ReadResponse](docs/ReadResponse.md)\n - [ReadValueId](docs/ReadValueId.md)\n - [ReaderGroupDataType](docs/ReaderGroupDataType.md)\n - [ReferenceDescription](docs/ReferenceDescription.md)\n - [RegisterNodesRequest](docs/RegisterNodesRequest.md)\n - [RegisterNodesResponse](docs/RegisterNodesResponse.md)\n - [RelativePath](docs/RelativePath.md)\n - [RelativePathElement](docs/RelativePathElement.md)\n - [RepublishRequest](docs/RepublishRequest.md)\n - [RepublishResponse](docs/RepublishResponse.md)\n - [RequestHeader](docs/RequestHeader.md)\n - [ResponseHeader](docs/ResponseHeader.md)\n - [RolePermissionType](docs/RolePermissionType.md)\n - [SecurityGroupDataType](docs/SecurityGroupDataType.md)\n - [SetMonitoringModeRequest](docs/SetMonitoringModeRequest.md)\n - [SetMonitoringModeResponse](docs/SetMonitoringModeResponse.md)\n - [SetPublishingModeRequest](docs/SetPublishingModeRequest.md)\n - [SetPublishingModeResponse](docs/SetPublishingModeResponse.md)\n - [SetTriggeringRequest](docs/SetTriggeringRequest.md)\n - [SetTriggeringResponse](docs/SetTriggeringResponse.md)\n - [SignatureData](docs/SignatureData.md)\n - [SignedSoftwareCertificate](docs/SignedSoftwareCertificate.md)\n - [SimpleAttributeOperand](docs/SimpleAttributeOperand.md)\n - [SimpleTypeDescription](docs/SimpleTypeDescription.md)\n - [StandaloneSubscribedDataSetDataType](docs/StandaloneSubscribedDataSetDataType.md)\n - [StatusChangeNotification](docs/StatusChangeNotification.md)\n - [StatusCode](docs/StatusCode.md)\n - [StructureDefinition](docs/StructureDefinition.md)\n - [StructureDescription](docs/StructureDescription.md)\n - [StructureField](docs/StructureField.md)\n - [StructureType](docs/StructureType.md)\n - [SubscriptionAcknowledgement](docs/SubscriptionAcknowledgement.md)\n - [TimestampsToReturn](docs/TimestampsToReturn.md)\n - [TransferResult](docs/TransferResult.md)\n - [TransferSubscriptionsRequest](docs/TransferSubscriptionsRequest.md)\n - [TransferSubscriptionsResponse](docs/TransferSubscriptionsResponse.md)\n - [TranslateBrowsePathsToNodeIdsRequest](docs/TranslateBrowsePathsToNodeIdsRequest.md)\n - [TranslateBrowsePathsToNodeIdsResponse](docs/TranslateBrowsePathsToNodeIdsResponse.md)\n - [UnregisterNodesRequest](docs/UnregisterNodesRequest.md)\n - [UnregisterNodesResponse](docs/UnregisterNodesResponse.md)\n - [UpdateDataDetails](docs/UpdateDataDetails.md)\n - [UpdateEventDetails](docs/UpdateEventDetails.md)\n - [UpdateStructureDataDetails](docs/UpdateStructureDataDetails.md)\n - [UserIdentityToken](docs/UserIdentityToken.md)\n - [UserNameIdentityToken](docs/UserNameIdentityToken.md)\n - [UserTokenPolicy](docs/UserTokenPolicy.md)\n - [UserTokenType](docs/UserTokenType.md)\n - [Variant](docs/Variant.md)\n - [ViewDescription](docs/ViewDescription.md)\n - [WriteRequest](docs/WriteRequest.md)\n - [WriteResponse](docs/WriteResponse.md)\n - [WriteValue](docs/WriteValue.md)\n - [WriterGroupDataType](docs/WriterGroupDataType.md)\n - [X509IdentityToken](docs/X509IdentityToken.md)\n\n\n\u003ca id=\"documentation-for-authorization\"\u003e\u003c/a\u003e\n## Documentation For Authorization\n\nEndpoints do not require authorization.\n\n\n## Author\n\noffice@opcfoundation.org\n\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fopcfoundation%2Fopcua-webapi-python","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fopcfoundation%2Fopcua-webapi-python","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fopcfoundation%2Fopcua-webapi-python/lists"}