Outdated documentation

You are looking at the documentation for an older release. For the latest information, please see current release documentation.

Web Services

The functionality needs to be configured in the Web Services module of the administrator interface. The package contains example configurations for both SOAP and REST methods.

To import the web service configuration:

1. Go to the Web Service Management screen in the administrator interface.
2. Click on the Add Web Service button in the left sidebar.
3. Click on the Import Web Service button in the left sidebar.
4. Select the file scripts/GenericLinkConnectorSOAP.yml or scripts/GenericLinkConnectorREST.yml within the OTRS home folder.
5. Click on the Import button.

These files contain the complete information to setup the web service. The web service can be customized after the import process, if needed. The result of this process will be the same as the manual procedure explained below, but with some useful comments are added to the operations. The imported web services are ready and able to handle all the new operations provided in this package.

It is possible to setup the configuration manually, if you would not like to use the builtin configuration examples.

Note

The following steps are needed only, when the web services were not imported as explained above.

The following steps are required to provide a full working configuration:

1. Go to the Web Service Management screen in the administrator interface.

2. Click on the Add Web Service button in the left sidebar.

3. Fill the form with the following data:

   • Name: LinkObjectConnector
   • Debug threshold: Debug
   • Network transport: HTTP::SOAP

4. Click on the Save button to enable the Add Operation selection and the Configure button for network transport.

5. Click on the network transport Configure button to show the transport options.

6. Use the following parameters:

   • Namespace: https://otrs.org/LinkObjectConnector/
   • Maximum message length: 100000

7. Click on the Save button. Wait until the page refreshes and then click on the Go back to web service button to continue.

8. The Add Operation selection provides seven new operations for link:

   Link::LinkAdd
   Link::LinkDelete
   Link::LinkDeleteAll
   Link::LinkList
   Link::PossibleLinkList
   Link::PossibleObjectsLst
   Link::PossibleTypesList
   

9. Add the Link::LinkAdd operation and set the name LinkAdd in the next screen. It does not need any further configuration.

10. Click on the Save button. Wait until the page refreshes and then click on the Go back to web service button to continue.

11. Repeat step 9 and step 10 for the other six Link:: operations.

12. After adding all operations, click on the Save and Finish button from the Edit Web Service: LinkObjectConnector screen.

Now you are on the Web Service Management overview screen and the new web service is ready and able to handle all the new operations provided in this package.

Note

When the new web service is fully tested, the debug threshold could be changed to Notice. This will reduce the amount of data that will be kept in the database and only notice and error messages will be logged.