Api.browse - Siemens SIMATIC S7-1500 Function Manual

Web pages
3.20 API (Application Programming Interface)
3.20.2.3

Api.Browse

The Api.Browse method gives you a list of all methods that you can call via the Web API.
This provides you with an overview of all the methods supported by the CPU.
No authorizations are needed for calling the Api.Browse method.
Example
The following example shows the HTTP request and a possible result of the request for the
Api.Browse method.
POST /api/jsonrpc HTTP/1.1
Host: 192.168.3.14
Content type: application/json
Content length: 48
[{"jsonrpc":"2.0","method":"Api.Browse","id":1}]
Response of the server:
[
{ "name": "Api.Browse" },
{ "name": "Api.GetCertificateUrl" },
{ "name": "Api.GetPermissions" },
{ "name": "Api.Login" },
{ "name": "Api.Logout" },
{ "name": "Api.Ping" },
{ "name": "Api.Version" },
{ "name": "PlcProgram.Browse" },
{ "name": "PlcProgram.Read" },
{ "name": "PlcProgram.Write" },
]
Note
Checking authorizations
The Api.Browse methods does not filter the list of the available methods by the individual
authorizations of users.
The list of available methods may therefore contain methods which the user may not execute
without authorization.
Possible error messages
The following table shows the possible error messages of the Api.Browse method.
Error code Error message
4 No resources
164
Meaning
The system does not have the necessary resources to execute the Web API request.
Carry out the request again as soon as sufficient resources are available again.
Function Manual, 11/2019, A5E03484625-AG
Web server