WebserviceResources model configurations for DTS resources as it pertains to their inclusion in designed Webservices.
{
"connector" : "",
"remoteName" : "",
"name" : "",
"streamPathPrefix" : "",
"methsMetadata" : {}
}
Attribute |
Value |
Note |
connector |
The _id of the connector the resource belongs to. |
|
remoteName |
The native identifier of the resource. |
|
name |
The custom name given to the resource inside the webservice, if any. |
Only applies to remote call resources. For REST webservices it is reflected in the operation's URL, while for SOAP webservices it becomes the operation's name. |
streamPathPrefix |
The URL prefix that will be used for streaming operations on the resource. |
Only applies to streaming resources in REST webservices. |
methsMetadata |
An map of the settings for streaming operations on this resource. |
Only applies to streaming resources. |
Streaming Operation Settings
The methsMetadata attribute contains a map whose keys represent the identifiers for the possible streaming operations on a resource. The presence of an item implies its inclusion in the Webservice.
open_stream_w_inline |
Open a stream with URL query parameters (REST only) Has a fields attribute which lists all fields which will be available as query parameters in the resulting GET operation. |
open_stream_w_predicate |
Open a stream using a predicate (SOAP & REST). When used in a REST webservice, it results in a POST operation. |
get_stream_records |
Get records from a stream (SOAP & REST). Mandatory if any Open Stream operation is enabled. |
get_stream_records_w_inline |
Get a set of records with URL query parameters (REST only) Has a fields attribute which lists all fields which will be available as query parameters in the resulting GET operation. |
get_stream_records_w_predicate |
Get a set of records using a predicate (SOAP & REST). When used in a REST webservice, it results in a POST operation. |
get_stream_record_w_key |
Get a single record using a unique field (SOAP & REST). Has a fields attribute which will contain a single element representing the chosen field's name. |
All entries can have a name attribute which sets a custom operation name (SOAP) or a custom URL suffix (REST).
For more information on Webservice streaming operations, please see Webservices - Access.