The tia Webservice exposes the following APIs.
Service name | Service method | Description | Parameter Description | Return codes | Availability |
---|---|---|---|---|---|
ServiceCheck | String ServiceCheck(String ApplicationName, String UserName, String seckey) | This API may be used in order to check whether a service is available for an application. This API returns the application name. Please note: In case an application is configured and deactivated, it will still return the application name. | ApplikationName: Application which is mapped against a specific Content Server. UserName: Username which is delivered / provided by the client (Authentication should be handled at the remote end. Webservice itself doesn’t offer user authentication.) seckey: The seckey represents a signed ApplicationName. In case the security is enabled and the alias is specified, the seckey will be verified against the configured alias in the keystore. | Returns a string indicating whether web service is availble for the specified application name. | API available since version 1 |
serverInfo | int ContentServerInfo(String ApplicationName, String UserName, String seckey) | API may be used to check whether configured content server is available. This API is equivalent to an SAP ArchiveLink Server Info-command. It returns a response code. Please refer to SAP Content Server HTTP Interface guide for more details regarding the response code. | ApplicationName: Application which is mapped against a specified Content Server UserName: Username which is provided by the client (Authentication should be handled at the remote end. Webservice itself doesn’t offer user authentication.) seckey: The seckey represents a signed ApplicationName. In case the security is enabled and the alias is specified, the seckey will be verified against the configured alias in the keystore. | 200: OK 400: Bad request
401: Forbidden
500: Internal Server Error
| 1 |