✕
✕

Configure

TIA
Network REST Client ActiveClients One client

ns=2;s=DEPRAG Smart/Network/HTTP/REST/ActiveClients/0/Configure

Configures a REST client. This command must be executed if the client has been added via the AddUnparameterizedClient method or one of the 10 clients created by default is used.

Parameters:

    ConnectionTimeoutInMilliseconds
    Maximum time in milliseconds for establishing a connection to the REST API. If a connection cannot be established within the time interval, an error is issued.
    TlsVersion
    TLS version used for encryption:
    SSL2, SSL3, TLS, Default, TLS11, TLS12, TLS13
    UserName
    Username used to authenticate to the specified REST API.
    Password
    Password used to authenticate to the specified REST API.
    ApiToken
    API token used to authenticate to the specified REST API.
    AcceptSelfSignedCertificates
    Specifies whether unsigned certificates are accepted. If this value is set to yes, the application can connect to REST APIs with self-signed certificates.
    Compression
    Sets the compression algorithm:
    All
    None
    Gzip
    Deflate
    Brotli

Returns:

    Configure
    A variable of the OpcMethodReturnValueVoid type. The method has no command-specific return values.

Examples:

For examples and explanations regarding the calls of nodes via Siemens TIA Portal please refer to the sub-menu "Siemens TIA Portal" in section "Getting Started".