Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 3 Next »

The tia Webservice exposes the following APIs.

Service name

Service method

Description

Parameter Description

Return codes / Return Type

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

  • Check if application is active

  • Check if specified application name is correct on both sides

  • Check if username is delivered by remote end

401: Forbidden

  • Check if seckey is valid

  • Check if instance is allowed to do serverinfo-requests

  • Check if the correct certificate is being used which is mapped against an alias and the common name (CN) contains the application name.

500: Internal Server Error

  • Check logs for additional details

1

info

Document ContentServerDocInfo(String ApplicationName, Document document, String UserName, String seckey)

The API may be used in order to fetch information regarding a certain Document and its respective components. This API returns a Document structure which should be implemented by the client application. Please refer to Structures used in Webservice (WA) for additional information.

ApplicationName: Application which is mapped against a specific Content Server.

document: A document structure needs to be provided with the following fields filled.

  • DocID

  • UserName

  • (Optional) Component ID

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. (Seckey is optional for info-Requests).

Returns a document structure containing the following.

  • DocId

  • Component ID ( Please note: In case the document contains multiple components, only one component Id will be returned)

  • Component size

  • Doc Type mapped against MimeType

  • HTTP Return code

Return code:

200: OK

400: Bad request

  • Check if application is active

  • Check if specified application name is correct on both sides

  • Check if username is delivered by remote end

401: Forbidden

  • Check if seckey is valid

  • Check if instance is allowed to do serverinfo-requests

  • Check if the correct certificate is being used which is mapped against an alias and the common name (CN) contains the application name.

500: Internal Server Error

  • Check logs for additional details

1

delete

int ContentServerDocDel(String ApplicationName, Document document, String UserName, String seckey)

This API may be used in order to delete the specified document.

ApplicationName: Application which is mapped against a specific Content Server.

document: A document structure needs to be provided with the following fields filled.

  • DocID

  • (Optional) Component ID

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. (Seckey is optional for delete-Requests).

Return code:

200: OK

400: Bad request

  • Check if application is active

  • Check if specified application name is correct on both sides

  • Check if username is delivered by remote end

401: Forbidden

  • Check if seckey is valid

  • Check if instance is allowed to do serverinfo-requests

  • Check if the correct certificate is being used which is mapped against an alias and the common name (CN) contains the application name.

500: Internal Server Error

  • Check logs for additional details

1

get

Document ContentServerDocGet(String ApplicationName, Document document, String UserName, String seckey)

This API may be used in order to fetch the specified document. In case no component was specified the default data component will be fetched.

ApplicationName: Application which is mapped against a specific Content Server.

document: A document structure needs to be provided with the following fields filled.

  • DocID: The document ID which was given to the document when it has been archived.

  • (Optional) CompID: The component ID which should be retrieved from the document.

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. (Seckey is optional for delete-Requests).

Returns a document structure containing the following:

  • An array of bytes containing the component

  • The size of the component

  • The document type mapped against a mime type.

  • The HTTP Return code.

Return code:

200: OK

400: Bad request

  • Check if application is active

  • Check if specified application name is correct on both sides

  • Check if username is delivered by remote end

401: Forbidden

  • Check if seckey is valid

  • Check if instance is allowed to do serverinfo-requests

  • Check if the correct certificate is being used which is mapped against an alias and the common name (CN) contains the application name.

500: Internal Server Error

  • Check logs for additional details

1

MDocument ContentServerDocGetv2(String ApplicationName, MDocument recvDoc, String UserName, String seckey, Boolean ConvertToPdf, String Watermark)

2

  • No labels