Plcprogram.browse - Siemens SIMATIC S7-1500 Function Manual

Response structure
If the write operation was successful, the server returns the Boolean value "true".
Possible error messages
The following table shows the possible error messages of the PlcProgram.Read method.
Error code Error message
1 Internal error
2 Permission denied The current authentication token is not authorized to call this method.
4 No resources
200 Address does not
exist
201 Invalid address
203 Invalid array index The dimensions and limits of the array indexes do not correspond to the type information
204 Unsupported
address
3.20.5.5

PlcProgram.Browse

The PlcProgram.Browse method allows you to search tags and the corresponding metadata
according to your individual requirements.
To call the PlcProgram.Browse method, you need the "read_value" authorization.
Structure of the request
The following table informs you about the properties of the tag to be searched.
Name Required
"var" See "Descripti-
on" column
"mode" Yes
Web server
Function Manual, 11/2019, A5E03484625-AG
Meaning
An internal error occurred while trying to perform the requested operation.
Log on with a user account that has sufficient privileges to call this method.
The system does not have the necessary resources to read the requested address.
Carry out the request again as soon as sufficient resources are available again.
The requested address does not exist or the web server cannot access the requested
address.
The structure of the name of the symbolic address is not correct.
of the CPU.
The data type of the address cannot be written.
Data type Description
String Name of the tag to be searched
If "mode" = "var", this attribute is required. The Browse method se-
•
arches for the tag to find the metadata of the tag.
If "mode" = "children", this attribute is optional. The Browse method
•
searches for the tag and returns a list of child tags and metadata.
String Enumeration that determines the behavior of this method:
"var": Displays information about the specified tag.
•
"children": Displays information about the direct children of the spe-
•
cified tag
3.20 API (Application Programming Interface)
Web pages
179