When a Collection 
or Aggregate 
is selected in the Webservice Assets Drawer, the Details Drawer will show all the options for configuring Webservice operations that allow clients to interact with streams on that resource.
This allows fine tuning of the interface by which data from the resource is accessed using the Webservice.
Webservices View with Stream Operations Drawer
This section is the master control for all stream methods on this collection.
Native Name |
Shows the full native name of the selected Resource (view-only) |
URL Prefix |
The URL element(s) that will be used to point to WS methods for this collection |
The default value of URL Prefix is [CONNECTOR_NAME]/[COLLECTION_NAME]
The URL Prefix only identifies the targeted collection within the Webservice. To access a particular Stream Method, more elements must be added to the URL as described in the next paragraphs.
Open Stream by Query
This section provides options for the Webservice method that will open a stream on the selected resource using a query based on in-line parameter values provided in the URL (i.e. a REST GET request)
Open Stream by Query |
Toggles whether this method will be included in the Webservice |
Query Parameters |
Allows you to choose which fields you want to make available as query parameters within the GET method URL
|
GET URL |
Shows what the complete URL for calling the method will look like (view-only) |
All the parameters in the GET URL (after '?') are optional. Any combination can be used. If none are included, a stream spanning all records provided by the resource will be created.
This method is only available for REST services, as SOAP does not allow URL parameters.
Open Stream by Predicate
This section provides options for the Webservice method that will open a stream on the selected resource using a query based on a DTS Predicate object which will be included in the request body (i.e. a REST POST or SOAP request).
Open Stream by Predicate |
Toggles whether this method will be included in the Webservice |
Method Name |
The name you want the method to be accessed with (default "stream-with-pred") |
POST URL |
Shows what the complete URL for calling the method will look like (view-only) |
The Method Name serves as a URL element in the case of REST POST and as an actual method name for SOAP.
When configuring a SOAP method, the Method Name needs to be a valid Java method name.
The POST URL is only significant for REST, as SOAP methods are all accessed using the base endpoint URL.
Get Records From Stream
This section provides options for the Webservice method that will request records from an open stream.
Get Records From Stream |
Shows if the method is included or not. This cannot be manually toggled, instead it will be on if any of the Open Stream methods are included and off otherwise. |
Method Name |
The name you want the method to be accessed with (default "stream-get") |
GET URL |
Shows what the complete URL for calling the method will look like (view-only) |
The Method Name serves as a URL element in the case of REST POST and as an actual method name for SOAP.
When configuring a SOAP method, the Method Name needs to be a valid Java method name.
The POST URL is only significant for REST, as SOAP methods are all accessed using the base endpoint URL.
The Method always has the same 2 parameters: stream_id and dts__size, which are fed inline for REST GET requests and within the body for SOAP requests. The stream_id parameter is mandatory, while dts__size is considered 1 if missing.
Get Records With Inline Parameters
This section provides options for the Webservice method that will execute a one-time query on the resource based on in-line parameter values provided in the URL (i.e. a REST GET request)
Get Records by Query |
Toggles whether this method will be included in the Webservice |
Method Name |
The name you want the method to be accessed with (default "records") |
Query Parameters |
Allows you to choose which fields you want to make available as query parameters within the GET method URL
|
GET URL |
Shows what the complete URL for calling the method will look like (view-only) |
All the parameters in the GET URL (after '?') are optional. Any combination can be used. If none are included, the first [dts__size] records provided by the resource will be returned.
This method is only available for REST services, as SOAP does not allow URL parameters.
This method is equivalent to and a shortcut for opening a stream with the same parameters, making a records request of the desired size and closing the stream.
The dts__size parameter is always available (if not used, a single record will be requested).
Get Records by Predicate
This section provides options for the Webservice method that will execute a one-time query on the selected resource based on a DTS Predicate object and a given size which will be included in the request body (i.e. a REST POST or SOAP request).
Get Records by Predicate |
Toggles whether this method will be included in the Webservice |
Method Name |
The name you want the method to be accessed with (default "records-with-pred") |
POST URL |
Shows what the complete URL for calling the method will look like (view-only) |
The Method Name serves as a URL element in the case of REST POST and as an actual method name for SOAP.
When configuring a SOAP method, the Method Name needs to be a valid Java method name.
The POST URL is only significant for REST, as SOAP methods are all accessed using the base endpoint URL.
This method is equivalent to and a shortcut for opening a stream with the same Predicate, making a records request of the desired size and closing the stream.
The size parameter is considered to be 1 if missing.
Get Record by Key
This section provides options for the Webservice method that will execute a one-time query on the selected resource and return the first record found. It should be configured to use a unique field.
Get Record by Key |
Toggles whether this method will be included in the Webservice |
Key Field |
The field that will be used as key for finding records
|
GET URL |
Shows what the complete URL for calling the method will look like (view-only) |
One and only one field can be selected. If the resource has a declared primary key formed of a single field, it will be pre-selected.
This method is only available for REST services, as SOAP does not allow URL parameters.
This method is equivalent to and a shortcut for opening a stream with the key parameter, making a one record request and closing the stream.
To read more about the DTS URL format, see Webservice Access