<< Click to Display Table of Contents >> Navigation:  Webservices > Access

 

This section explains how DTS Webservice functionality is accessed.

 

All operation URLs for DTS Webservices will have the following form:

[APP_SERVER_URL]/[WEBSERVICE_NAME]/[MAIN_ELEMENT]/[OPERATION_ELEMENTS]

 

 

Asset elements vary by the service and operation types, and we will detail them here.

 

SOAP Asset Elements

 

A DTS SOAP service uses a single endpoint, and therefore a single URL to access all of its functionality. Details regarding operations and parameters will be included in the SOAP Request Body.

As such, the OPERATION_ELEMENTS part of the URL for SOAP services is not present, the endpoint URL resolving to simply:

[APP_SERVER_URL]/[WEBSERVICE_NAME]/[MAIN_ELEMENT]

 

Example:

http://my.tomcat.srv:8080/prj1_coolservice_DEV_v3/app

 

 

REST Asset Elements

 

REST services identify operations through their specific URLs, which can also codify parameter values in the case of GET requests. We will look at each request type separately.

 

REST Remote Routine Calls

 

The OPERATION_ELEMENTS part of a REST Remote Routine Call URL is fully customizable from the Webservice Routine Details Drawer.

By default, it is [CONNECTOR_NAME]/[NATIVE_ROUTINE_NAME]

If all of the routine's inputs are supported as Query Parameters, this will be a GET request and the inputs can be fed inline.

Example:

http://my.tomcat.srv:8080/prj1_coolservice_DEV_v3/app/postgres/a_complicated_proc?arg1=something&arg2=something_else

 

REST Collection Stream Operations

 

The OPERATION_ELEMENTS for these operations are split into two parts, both customizable in the Webservice Stream Operations Drawer.

[URL_PREFIX]/[METHOD_NAME]

 

URL_PREFIX will apply to the URLs for all operations on a given collection. Its default is [CONNECTOR_NAME]/[NATIVE_COLLECTION_NAME]

Example (up to and including URL_PREFIX):

http://my.tomcat.srv:8080/prj1_coolservice_DEV_v3/app/postgres/nice_table

 

METHOD_NAME identifies the specific operation to be executed:

 

REST Topic Operations

 

The OPERATION_ELEMENTS for these operations are split into two parts, both customizable in the Webservice Topic Operations Drawer.

[URL_PREFIX]/[METHOD_NAME]

 

URL_PREFIX will apply to the URLs for all operations on a given collection. Its default is [CONNECTOR_NAME]/[NATIVE_TOPIC_NAME]

Example (up to and including URL_PREFIX):

http://my.tomcat.srv:8080/prj1_coolservice_DEV_v3/app/kafka/some_topic

 

METHOD_NAME identifies the specific operation to be executed:

 

REST Generic Stream Operations

 

Stream closing and querying whether a stream has more records are operations which are independent of the specific collection the stream is opened on, as they only require the stream_id .

As a result, they do not use the COLLECTION_PATH_PREFIX above and are derived from the base service URL instead.