| Namespace | http://www.mulesoft.org/schema/mule/servicesource |
|---|---|
| Schema Location | http://www.mulesoft.org/schema/mule/servicesource/current/mule-servicesource.xsd (View Schema) |
| Schema Version | 1.0 |
| Minimum Mule Version | 3.4 |
ServiceSource Cloud Connector. The ServiceSource Connector will allow to use the ServiceSource REST API. Almost every operation that can be done via the API can be done through this connector.
| Configuration | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
Configure an instance of this module
| |||||||||||
| Message Processors | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
This method allows searching on the analysis API.
| |||||||||||
This processor must be invoked to indicatethat the data load job has completed.
| |||||||||||
Generic method to create entities in dynamic collections
| |||||||||||
Creates new address
| |||||||||||
Creates a new Asset
| |||||||||||
Creates a new Booking
| |||||||||||
Creates new contact
| |||||||||||
Creates a new forecast
| |||||||||||
Creates a new lookup
| |||||||||||
Creates a new note
| |||||||||||
Creates new offer
| |||||||||||
Creates a new opportunity
| |||||||||||
Creates a new Product
| |||||||||||
Creates a new Quote
| |||||||||||
Creates a new Task
| |||||||||||
Removes the object from the collection, permitting reference checks.
| |||||||||||
Generic method to create entities dynamicly using DataSense.
| |||||||||||
Pushes data through the load API.
| |||||||||||
Export a collection.
| |||||||||||
Executes a method on the object of a collection.
| |||||||||||
Invoke Static Method
Executes a static method on the collection.
| |||||||||||
Pushes data through the load API.
| |||||||||||
Consumes the lookups config API looking for a lookup for the given connection on the given propertyPath.
| |||||||||||
This method provides basic search capabilities through a collection by providing a mongo formatted query.
| |||||||||||
Generic method to read entities from dynamic collections
| |||||||||||
Fetches the address identified by the object id.
| |||||||||||
Fetches the Asset identified by the object id.
| |||||||||||
Fetches the Booking identified by the object id.
| |||||||||||
Fetches the contact identified by the object id.
| |||||||||||
Fetches the forecast identified by the object id.
| |||||||||||
Fetches the note identified by the object id.
| |||||||||||
Fetches the offer identified by the object id.
| |||||||||||
Fetches the opportunity identified by the object id.
| |||||||||||
Fetches the Product identified by the object id.
| |||||||||||
Fetches the Quote identified by the object id.
| |||||||||||
Fetches the Task identified by the object id.
| |||||||||||
This method provides search capabilities by specifying filters through a map.
| |||||||||||
Starts a Data Load by creating an entry in the data load collection.
| |||||||||||
Generic method to update entities from dynamic collections
| |||||||||||
Updates an address
| |||||||||||
Updates an Asset
| |||||||||||
Updates a Booking
| |||||||||||
Updates a given contact
| |||||||||||
Updates a forecast
| |||||||||||
Updates a given note
| |||||||||||
Updates an offer
| |||||||||||
Updates an opportunity
| |||||||||||
Updates a Product
| |||||||||||
Updates a Quote
| |||||||||||
Updates a Task
| |||||||||||
To use the this module within a flow the namespace to the module must be included. The resulting flow will look similar to the following:
<mule xmlns="http://www.mulesoft.org/schema/mule/core"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:servicesource="http://www.mulesoft.org/schema/mule/servicesource"
xsi:schemaLocation="
http://www.mulesoft.org/schema/mule/core
http://www.mulesoft.org/schema/mule/core/current/mule.xsd
http://www.mulesoft.org/schema/mule/servicesource
http://www.mulesoft.org/schema/mule/servicesource/current/mule-servicesource.xsd">
<!-- here goes your flows and configuration elements -->
</mule>
This module is configured using the config element. This element must be placed outside of your flows and at the root of your Mule application. You can create as many configurations as you deem necessary as long as each carries its own name.
Each message processor, message source or transformer carries a config-ref attribute that allows the invoker to specify which configuration to use.
| Attributes | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| Type | Name | Default Value | Description | Java Type | MIME Type | Encoding | Optional. Give a name to this configuration so it can be later referenced. | ||||
| /analysis/api/ | Optional. The relative URL where the analysis API calls are made | ||||||||||
| /rest/api/ | Optional. The relative URL where the main API calls are made. | ||||||||||
| 0 | Optional. The connect timeout interval, in milliseconds | ||||||||||
| /login.json | Optional. The relative url of the endpoint that handles login | ||||||||||
| 0 | Optional. The read timeout interval, in milliseconds | ||||||||||
This connector offers automatic connection management via the use of a connection pool. The pool will act a storage mechanism for all the connections that are in-use by the user of this connector.
Prior to execution of a processor, the connector will attempt to lookup an already established connection and if one doesn't exists it will create one. That lookup mechanism is done in the connection pool via the use of connection variables declared as keys.
The user of the connector can configure the pool by adding a connection-pooling-profile to the connector configuration like this:
<servicesource:connection-pooling-profile maxActive="10" maxIdle="10"
exhaustedAction="WHEN_EXHAUSTED_GROW" maxWait="120" minEvictionMillis="60000" evictionCheckIntervalMillis="30000"/>
The following is a list of connection attributes, each connection attribute can be configured at the config element level or they can also be added to each processor. If they are used at the processor level they get the benefit of full expression resolution.
| Connection Attributes | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| Name | Default Value | Description | Java Type | MIME Type | Encoding | ||||||
| Optional. Specify which configuration to use. | |||||||||||
| Application username | String | */* | UTF-8 | ||||||||
| Application password | String | */* | UTF-8 | ||||||||
| URL of the SRPS server API | String | */* | UTF-8 | ||||||||
| Name of the tenant | String | */* | UTF-8 | ||||||||
Reconnection Strategies specify how a connector behaves when its connection fails. You can control how Mule attempts to reconnect by specifying a number of criteria:
With a reconnection strategy, you can better control the behavior of a failed connection, by configuring it, for example, to re-attempt the connection only once every 15 minutes, and to give up after 30 attempts. You can also send an automatic notification to your IT administrator whenever this reconnection strategy goes into effect. You can even define a strategy that attempts to reconnect only during business hours. Such a setting can prove useful if your server is frequently shut down for nightly maintenance.
A reconnection strategy that allows the user to configure how many times a reconnection should be attempted and how long to wait between attempts.
<servicesource:config>
<reconnect count="5" frequency="1000"/>
</servicesource:config>
| Reconnect Attributes | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| Name | Default Value | Description | |||||||||
| Optional. How often (in ms) to reconnect | |||||||||||
| Optional. How many reconnection attempts to make | |||||||||||
For more information about reconnection strategies in Mule, or even how to write your own custom reconnection strategy please check this section.
This method allows searching on the analysis API.
INCLUDE_ERROR
| Name | Default Value | Description | Java Type | MIME Type | Encoding | ||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| Optional. Specify which configuration to use. | |||||||||||
| The collection to query | AnalysisCollection | */* | |||||||||
| Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation. | |||||||||||
| Optional. Application username | String | */* | UTF-8 | ||||||||
| Optional. Application password | String | */* | UTF-8 | ||||||||
| Optional. URL of the SRPS server API | String | */* | UTF-8 | ||||||||
| Optional. Name of the tenant | String | */* | UTF-8 | ||||||||
| Name | Default Value | Description | Java Type |
|---|---|---|---|
| Optional. Map that includes filters | Map<String, Object> |
| Return Type | Description |
|---|---|
| AnalysisObject | the actual type of the return value depends on the provided collection, but it will be an implementation of AnalysisObject
|
This processor must be invoked to indicatethat the data load job has completed. This call must be made after all the in-progress load calls complete. The done API can optionally contain summary statistics about the loaded data organized by input source.
INCLUDE_ERROR
| Name | Default Value | Description | Java Type | MIME Type | Encoding | ||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| Optional. Specify which configuration to use. | |||||||||||
| #[payload] | Optional. An instance of DataLoadCompleteRequest with the comple data load request data |
DataLoadCompleteRequest | */* | ||||||||
| The id of the data load job. | String | */* | UTF-8 | ||||||||
| Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation. | |||||||||||
| Optional. Application username | String | */* | UTF-8 | ||||||||
| Optional. Application password | String | */* | UTF-8 | ||||||||
| Optional. URL of the SRPS server API | String | */* | UTF-8 | ||||||||
| Optional. Name of the tenant | String | */* | UTF-8 | ||||||||
Generic method to create entities in dynamic collections
INCLUDE_ERROR
| Name | Default Value | Description | Java Type | MIME Type | Encoding | ||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| Optional. Specify which configuration to use. | |||||||||||
A member of the ServiceSourceCollection enum representing the collection that owns the entity |
ServiceSourceCollection | */* | |||||||||
| #[payload] | Optional. A subclass instance of ServiceSourceEntity |
ServiceSourceEntity | */* | ||||||||
| Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation. | |||||||||||
| Optional. Application username | String | */* | UTF-8 | ||||||||
| Optional. Application password | String | */* | UTF-8 | ||||||||
| Optional. URL of the SRPS server API | String | */* | UTF-8 | ||||||||
| Optional. Name of the tenant | String | */* | UTF-8 | ||||||||
| Return Type | Description |
|---|---|
| ServiceSourceEntity | a subclass instance of ServiceSourceEntity with the created entity
|
Creates new address
INCLUDE_ERROR
| Name | Default Value | Description | Java Type | MIME Type | Encoding | ||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| Optional. Specify which configuration to use. | |||||||||||
| #[payload] | Optional. A Address |
Address | */* | ||||||||
| Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation. | |||||||||||
| Optional. Application username | String | */* | UTF-8 | ||||||||
| Optional. Application password | String | */* | UTF-8 | ||||||||
| Optional. URL of the SRPS server API | String | */* | UTF-8 | ||||||||
| Optional. Name of the tenant | String | */* | UTF-8 | ||||||||
Creates a new Asset
INCLUDE_ERROR
| Name | Default Value | Description | Java Type | MIME Type | Encoding | ||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| Optional. Specify which configuration to use. | |||||||||||
| #[payload] | Optional. A org.mule.module.servicesource.model.Asset | Asset | */* | ||||||||
| Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation. | |||||||||||
| Optional. Application username | String | */* | UTF-8 | ||||||||
| Optional. Application password | String | */* | UTF-8 | ||||||||
| Optional. URL of the SRPS server API | String | */* | UTF-8 | ||||||||
| Optional. Name of the tenant | String | */* | UTF-8 | ||||||||
| Return Type | Description |
|---|---|
| Asset | a org.mule.module.servicesource.model.Asset representing the newly created Asset |
Creates a new Booking
INCLUDE_ERROR
| Name | Default Value | Description | Java Type | MIME Type | Encoding | ||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| Optional. Specify which configuration to use. | |||||||||||
| #[payload] | Optional. A org.mule.module.servicesource.model.Booking | Booking | */* | ||||||||
| Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation. | |||||||||||
| Optional. Application username | String | */* | UTF-8 | ||||||||
| Optional. Application password | String | */* | UTF-8 | ||||||||
| Optional. URL of the SRPS server API | String | */* | UTF-8 | ||||||||
| Optional. Name of the tenant | String | */* | UTF-8 | ||||||||
| Return Type | Description |
|---|---|
| Booking | a org.mule.module.servicesource.model.Booking representing the newly created Booking |
Creates new contact
INCLUDE_ERROR
| Name | Default Value | Description | Java Type | MIME Type | Encoding | ||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| Optional. Specify which configuration to use. | |||||||||||
| #[payload] | Optional. A Contact |
Contact | */* | ||||||||
| Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation. | |||||||||||
| Optional. Application username | String | */* | UTF-8 | ||||||||
| Optional. Application password | String | */* | UTF-8 | ||||||||
| Optional. URL of the SRPS server API | String | */* | UTF-8 | ||||||||
| Optional. Name of the tenant | String | */* | UTF-8 | ||||||||
Creates a new forecast
INCLUDE_ERROR
| Name | Default Value | Description | Java Type | MIME Type | Encoding | ||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| Optional. Specify which configuration to use. | |||||||||||
| #[payload] | Optional. A Forecast |
Forecast | */* | ||||||||
| Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation. | |||||||||||
| Optional. Application username | String | */* | UTF-8 | ||||||||
| Optional. Application password | String | */* | UTF-8 | ||||||||
| Optional. URL of the SRPS server API | String | */* | UTF-8 | ||||||||
| Optional. Name of the tenant | String | */* | UTF-8 | ||||||||
Creates a new lookup
INCLUDE_ERROR
| Name | Default Value | Description | Java Type | MIME Type | Encoding | ||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| Optional. Specify which configuration to use. | |||||||||||
| #[payload] | Optional. A Lookup |
Lookup | */* | ||||||||
| Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation. | |||||||||||
| Optional. Application username | String | */* | UTF-8 | ||||||||
| Optional. Application password | String | */* | UTF-8 | ||||||||
| Optional. URL of the SRPS server API | String | */* | UTF-8 | ||||||||
| Optional. Name of the tenant | String | */* | UTF-8 | ||||||||
Creates a new note
INCLUDE_ERROR
| Name | Default Value | Description | Java Type | MIME Type | Encoding | ||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| Optional. Specify which configuration to use. | |||||||||||
| #[payload] | Optional. A Note |
Note | */* | ||||||||
| Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation. | |||||||||||
| Optional. Application username | String | */* | UTF-8 | ||||||||
| Optional. Application password | String | */* | UTF-8 | ||||||||
| Optional. URL of the SRPS server API | String | */* | UTF-8 | ||||||||
| Optional. Name of the tenant | String | */* | UTF-8 | ||||||||
Creates new offer
INCLUDE_ERROR
| Name | Default Value | Description | Java Type | MIME Type | Encoding | ||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| Optional. Specify which configuration to use. | |||||||||||
| #[payload] | Optional. A Offer |
Offer | */* | ||||||||
| Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation. | |||||||||||
| Optional. Application username | String | */* | UTF-8 | ||||||||
| Optional. Application password | String | */* | UTF-8 | ||||||||
| Optional. URL of the SRPS server API | String | */* | UTF-8 | ||||||||
| Optional. Name of the tenant | String | */* | UTF-8 | ||||||||
Creates a new opportunity
INCLUDE_ERROR
| Name | Default Value | Description | Java Type | MIME Type | Encoding | ||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| Optional. Specify which configuration to use. | |||||||||||
| #[payload] | Optional. A Opportunity |
Opportunity | */* | ||||||||
| Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation. | |||||||||||
| Optional. Application username | String | */* | UTF-8 | ||||||||
| Optional. Application password | String | */* | UTF-8 | ||||||||
| Optional. URL of the SRPS server API | String | */* | UTF-8 | ||||||||
| Optional. Name of the tenant | String | */* | UTF-8 | ||||||||
| Return Type | Description |
|---|---|
| Opportunity | a Opportunity representing the newly created opportunity
|
Creates a new Product
INCLUDE_ERROR
| Name | Default Value | Description | Java Type | MIME Type | Encoding | ||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| Optional. Specify which configuration to use. | |||||||||||
| #[payload] | Optional. A org.mule.module.servicesource.model.Product | Product | */* | ||||||||
| Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation. | |||||||||||
| Optional. Application username | String | */* | UTF-8 | ||||||||
| Optional. Application password | String | */* | UTF-8 | ||||||||
| Optional. URL of the SRPS server API | String | */* | UTF-8 | ||||||||
| Optional. Name of the tenant | String | */* | UTF-8 | ||||||||
| Return Type | Description |
|---|---|
| Product | a org.mule.module.servicesource.model.Product representing the newly created Product |
Creates a new Quote
INCLUDE_ERROR
| Name | Default Value | Description | Java Type | MIME Type | Encoding | ||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| Optional. Specify which configuration to use. | |||||||||||
| #[payload] | Optional. A org.mule.module.servicesource.model.Quote | Quote | */* | ||||||||
| Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation. | |||||||||||
| Optional. Application username | String | */* | UTF-8 | ||||||||
| Optional. Application password | String | */* | UTF-8 | ||||||||
| Optional. URL of the SRPS server API | String | */* | UTF-8 | ||||||||
| Optional. Name of the tenant | String | */* | UTF-8 | ||||||||
| Return Type | Description |
|---|---|
| Quote | a org.mule.module.servicesource.model.Quote representing the newly created Quote |
Creates a new Task
INCLUDE_ERROR
| Name | Default Value | Description | Java Type | MIME Type | Encoding | ||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| Optional. Specify which configuration to use. | |||||||||||
| #[payload] | Optional. A org.mule.module.servicesource.model.Task | Task | */* | ||||||||
| Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation. | |||||||||||
| Optional. Application username | String | */* | UTF-8 | ||||||||
| Optional. Application password | String | */* | UTF-8 | ||||||||
| Optional. URL of the SRPS server API | String | */* | UTF-8 | ||||||||
| Optional. Name of the tenant | String | */* | UTF-8 | ||||||||
| Return Type | Description |
|---|---|
| Task | a org.mule.module.servicesource.model.Task representing the newly created task |
Removes the object from the collection, permitting reference checks.
INCLUDE_ERROR
| Name | Default Value | Description | Java Type | MIME Type | Encoding | ||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| Optional. Specify which configuration to use. | |||||||||||
| The name of the collection | ServiceSourceCollection | */* | |||||||||
| Id of the object to delete. | String | */* | UTF-8 | ||||||||
| Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation. | |||||||||||
| Optional. Application username | String | */* | UTF-8 | ||||||||
| Optional. Application password | String | */* | UTF-8 | ||||||||
| Optional. URL of the SRPS server API | String | */* | UTF-8 | ||||||||
| Optional. Name of the tenant | String | */* | UTF-8 | ||||||||
Generic method to create entities dynamicly using DataSense. This method used a Map to represent entities instead of pojos.
INCLUDE_ERROR
| Name | Default Value | Description | Java Type | MIME Type | Encoding | ||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| Optional. Specify which configuration to use. | |||||||||||
| A String representation of a ServiceSource collection. For example: app.offers | String | */* | UTF-8 | ||||||||
| Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation. | |||||||||||
| Optional. Application username | String | */* | UTF-8 | ||||||||
| Optional. Application password | String | */* | UTF-8 | ||||||||
| Optional. URL of the SRPS server API | String | */* | UTF-8 | ||||||||
| Optional. Name of the tenant | String | */* | UTF-8 | ||||||||
| Name | Default Value | Description | Java Type |
|---|---|---|---|
| #[payload] | Optional. A Map representing the entity | Map<String, Object> |
| Return Type | Description |
|---|---|
| Map<String, Object> | a Map with a representation of the created entity |
Pushes data through the load API. The ID of the data load job must be included as input. Each invocation of the load API provides data for a single collection and parallel calls can be made to push data to multiple collections. The object content can be deduced from the data dictionary, metadata API or by fetching a pre-existing object using the object fetch API. Unlike its load-data counterpart, this version of the processor takes maps instead of pojos and includes support for DataSense.
INCLUDE_ERROR
| Name | Default Value | Description | Java Type | MIME Type | Encoding | ||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| Optional. Specify which configuration to use. | |||||||||||
A member of the ServiceSourceCollection enum representing the collection that owns the entities |
String | */* | UTF-8 | ||||||||
| The id of the data load job. | String | */* | UTF-8 | ||||||||
| false | Optional. If true performs an incremental load and the data may already exist and should be updated if it does rather than just added | boolean | */* | ||||||||
| Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation. | |||||||||||
| Optional. Application username | String | */* | UTF-8 | ||||||||
| Optional. Application password | String | */* | UTF-8 | ||||||||
| Optional. URL of the SRPS server API | String | */* | UTF-8 | ||||||||
| Optional. Name of the tenant | String | */* | UTF-8 | ||||||||
| Name | Default Value | Description | Java Type |
|---|---|---|---|
| #[payload] | Optional. A list with instances of ServiceSourceEntity all belonging to the same collection |
List<Map<String, Object>> |
Export a collection. You can optionally specify the columns you want to export and whether or not to use streaming
INCLUDE_ERROR
| Name | Default Value | Description | Java Type | MIME Type | Encoding | ||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| Optional. Specify which configuration to use. | |||||||||||
| The collection to query | ServiceSourceCollection | */* | |||||||||
| false | Optional. Wether or not use streaming | boolean | */* | ||||||||
| Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation. | |||||||||||
| Optional. Application username | String | */* | UTF-8 | ||||||||
| Optional. Application password | String | */* | UTF-8 | ||||||||
| Optional. URL of the SRPS server API | String | */* | UTF-8 | ||||||||
| Optional. Name of the tenant | String | */* | UTF-8 | ||||||||
| Name | Default Value | Description | Java Type |
|---|---|---|---|
| Optional. List of string specifying the columns to return | List<String> |
| Return Type | Description |
|---|---|
| List<ServiceSourceEntity> | A List of objects that matched the criteria. The actual type of those objects depends on the provided collection
but will be a subclass of ServiceSourceEntity
|
Executes a method on the object of a collection.
INCLUDE_ERROR
| Name | Default Value | Description | Java Type | MIME Type | Encoding | ||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| Optional. Specify which configuration to use. | |||||||||||
| The collection the object belongs to | ServiceSourceCollection | */* | |||||||||
| Id of the object. | String | */* | UTF-8 | ||||||||
| The object method to be invoked. | String | */* | UTF-8 | ||||||||
| Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation. | |||||||||||
| Optional. Application username | String | */* | UTF-8 | ||||||||
| Optional. Application password | String | */* | UTF-8 | ||||||||
| Optional. URL of the SRPS server API | String | */* | UTF-8 | ||||||||
| Optional. Name of the tenant | String | */* | UTF-8 | ||||||||
| Name | Default Value | Description | Java Type |
|---|---|---|---|
| #[payload] | Optional. The parameters for the specified method. | Map<String, Object> |
| Return Type | Description |
|---|---|
| List<Map<String, String>> | a list of maps representing the output of the invokation |
Invoke Static Method Executes a static method on the collection. These methods can perform actions across multiple objects.
INCLUDE_ERROR
| Name | Default Value | Description | Java Type | MIME Type | Encoding | ||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| Optional. Specify which configuration to use. | |||||||||||
| The name of the collection | ServiceSourceCollection | */* | |||||||||
| The static method to be invoked. | String | */* | UTF-8 | ||||||||
| Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation. | |||||||||||
| Optional. Application username | String | */* | UTF-8 | ||||||||
| Optional. Application password | String | */* | UTF-8 | ||||||||
| Optional. URL of the SRPS server API | String | */* | UTF-8 | ||||||||
| Optional. Name of the tenant | String | */* | UTF-8 | ||||||||
| Name | Default Value | Description | Java Type |
|---|---|---|---|
| #[payload] | Optional. The parameters for the specified method. | Map<String, Object> |
| Return Type | Description |
|---|---|
| List<Map<String, String>> | a list of maps representing the output object |
Pushes data through the load API. The ID of the data load job must be included as input. Each invocation of the load API provides data for a single collection and parallel calls can be made to push data to multiple collections. The object content can be deduced from the data dictionary, metadata API or by fetching a pre-existing object using the object fetch API.
INCLUDE_ERROR
| Name | Default Value | Description | Java Type | MIME Type | Encoding | ||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| Optional. Specify which configuration to use. | |||||||||||
A member of the ServiceSourceCollection enum representing the collection that owns the entities |
ServiceSourceCollection | */* | |||||||||
| The id of the data load job. | String | */* | UTF-8 | ||||||||
| false | Optional. If true performs an incremental load and the data may already exist and should be updated if it does rather than just added | boolean | */* | ||||||||
| Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation. | |||||||||||
| Optional. Application username | String | */* | UTF-8 | ||||||||
| Optional. Application password | String | */* | UTF-8 | ||||||||
| Optional. URL of the SRPS server API | String | */* | UTF-8 | ||||||||
| Optional. Name of the tenant | String | */* | UTF-8 | ||||||||
| Name | Default Value | Description | Java Type |
|---|---|---|---|
| #[payload] | Optional. A list with instances of ServiceSourceEntity all belonging to the same collection |
List<ServiceSourceEntity> |
| Return Type | Description |
|---|---|
| List<ServiceSourceEntity> | a list with instances of ServiceSourceEntity which represent the inserted objects
|
Consumes the lookups config API looking for a lookup for the given connection on the given propertyPath. If found, then the name of a lookup matching the displayName is returned
INCLUDE_ERROR
| Name | Default Value | Description | Java Type | MIME Type | Encoding | ||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| Optional. Specify which configuration to use. | |||||||||||
| The name of collection that the lookup referes to | String | */* | UTF-8 | ||||||||
| The property path of the lookup vlaue | String | */* | UTF-8 | ||||||||
| The displayName being looked up | String | */* | UTF-8 | ||||||||
| Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation. | |||||||||||
| Optional. Application username | String | */* | UTF-8 | ||||||||
| Optional. Application password | String | */* | UTF-8 | ||||||||
| Optional. URL of the SRPS server API | String | */* | UTF-8 | ||||||||
| Optional. Name of the tenant | String | */* | UTF-8 | ||||||||
| Return Type | Description |
|---|---|
| String | a String if the value was found, null otherwise |
This method provides basic search capabilities through a collection by providing a mongo formatted query. Take in count that the query is sent as a query param so per http protocol limitations there's a limit on the amount of characters that it can have. To post large filters use search instead.
INCLUDE_ERROR
| Name | Default Value | Description | Java Type | MIME Type | Encoding | ||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| Optional. Specify which configuration to use. | |||||||||||
| The collection to query | ServiceSourceCollection | */* | |||||||||
| A mongo formatted query | String | */* | UTF-8 | ||||||||
| Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation. | |||||||||||
| Optional. Application username | String | */* | UTF-8 | ||||||||
| Optional. Application password | String | */* | UTF-8 | ||||||||
| Optional. URL of the SRPS server API | String | */* | UTF-8 | ||||||||
| Optional. Name of the tenant | String | */* | UTF-8 | ||||||||
| Return Type | Description |
|---|---|
| List<ServiceSourceEntity> | A List of objects that matched the query. The actual type of those objects depends on the provided collection
but will be a subclass of ServiceSourceEntity
|
Generic method to read entities from dynamic collections
INCLUDE_ERROR
| Name | Default Value | Description | Java Type | MIME Type | Encoding | ||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| Optional. Specify which configuration to use. | |||||||||||
A member of the ServiceSourceCollection enum representing the collection that owns the entity |
ServiceSourceCollection | */* | |||||||||
| The id of the entity you want to get | String | */* | UTF-8 | ||||||||
| Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation. | |||||||||||
| Optional. Application username | String | */* | UTF-8 | ||||||||
| Optional. Application password | String | */* | UTF-8 | ||||||||
| Optional. URL of the SRPS server API | String | */* | UTF-8 | ||||||||
| Optional. Name of the tenant | String | */* | UTF-8 | ||||||||
| Return Type | Description |
|---|---|
| ServiceSourceEntity | a subclass instance of ServiceSourceEntity with the created entity
|
Fetches the address identified by the object id.
INCLUDE_ERROR
| Name | Default Value | Description | Java Type | MIME Type | Encoding | ||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| Optional. Specify which configuration to use. | |||||||||||
| Id of the object to read. | String | */* | UTF-8 | ||||||||
| Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation. | |||||||||||
| Optional. Application username | String | */* | UTF-8 | ||||||||
| Optional. Application password | String | */* | UTF-8 | ||||||||
| Optional. URL of the SRPS server API | String | */* | UTF-8 | ||||||||
| Optional. Name of the tenant | String | */* | UTF-8 | ||||||||
Fetches the Asset identified by the object id.
INCLUDE_ERROR
| Name | Default Value | Description | Java Type | MIME Type | Encoding | ||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| Optional. Specify which configuration to use. | |||||||||||
| Id of the object to read. | String | */* | UTF-8 | ||||||||
| Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation. | |||||||||||
| Optional. Application username | String | */* | UTF-8 | ||||||||
| Optional. Application password | String | */* | UTF-8 | ||||||||
| Optional. URL of the SRPS server API | String | */* | UTF-8 | ||||||||
| Optional. Name of the tenant | String | */* | UTF-8 | ||||||||
| Return Type | Description |
|---|---|
| Asset | an instance of org.mule.module.servicesource.model.forecast.Asset |
Fetches the Booking identified by the object id.
INCLUDE_ERROR
| Name | Default Value | Description | Java Type | MIME Type | Encoding | ||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| Optional. Specify which configuration to use. | |||||||||||
| Id of the object to read. | String | */* | UTF-8 | ||||||||
| Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation. | |||||||||||
| Optional. Application username | String | */* | UTF-8 | ||||||||
| Optional. Application password | String | */* | UTF-8 | ||||||||
| Optional. URL of the SRPS server API | String | */* | UTF-8 | ||||||||
| Optional. Name of the tenant | String | */* | UTF-8 | ||||||||
| Return Type | Description |
|---|---|
| Booking | an instance of org.mule.module.servicesource.model.forecast.Booking |
Fetches the contact identified by the object id.
INCLUDE_ERROR
| Name | Default Value | Description | Java Type | MIME Type | Encoding | ||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| Optional. Specify which configuration to use. | |||||||||||
| Id of the object to read. | String | */* | UTF-8 | ||||||||
| Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation. | |||||||||||
| Optional. Application username | String | */* | UTF-8 | ||||||||
| Optional. Application password | String | */* | UTF-8 | ||||||||
| Optional. URL of the SRPS server API | String | */* | UTF-8 | ||||||||
| Optional. Name of the tenant | String | */* | UTF-8 | ||||||||
Fetches the forecast identified by the object id.
INCLUDE_ERROR
| Name | Default Value | Description | Java Type | MIME Type | Encoding | ||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| Optional. Specify which configuration to use. | |||||||||||
| Id of the object to read. | String | */* | UTF-8 | ||||||||
| Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation. | |||||||||||
| Optional. Application username | String | */* | UTF-8 | ||||||||
| Optional. Application password | String | */* | UTF-8 | ||||||||
| Optional. URL of the SRPS server API | String | */* | UTF-8 | ||||||||
| Optional. Name of the tenant | String | */* | UTF-8 | ||||||||
Fetches the note identified by the object id.
INCLUDE_ERROR
| Name | Default Value | Description | Java Type | MIME Type | Encoding | ||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| Optional. Specify which configuration to use. | |||||||||||
| Id of the object to read. | String | */* | UTF-8 | ||||||||
| Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation. | |||||||||||
| Optional. Application username | String | */* | UTF-8 | ||||||||
| Optional. Application password | String | */* | UTF-8 | ||||||||
| Optional. URL of the SRPS server API | String | */* | UTF-8 | ||||||||
| Optional. Name of the tenant | String | */* | UTF-8 | ||||||||
Fetches the offer identified by the object id.
INCLUDE_ERROR
| Name | Default Value | Description | Java Type | MIME Type | Encoding | ||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| Optional. Specify which configuration to use. | |||||||||||
| Id of the object to read. | String | */* | UTF-8 | ||||||||
| Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation. | |||||||||||
| Optional. Application username | String | */* | UTF-8 | ||||||||
| Optional. Application password | String | */* | UTF-8 | ||||||||
| Optional. URL of the SRPS server API | String | */* | UTF-8 | ||||||||
| Optional. Name of the tenant | String | */* | UTF-8 | ||||||||
Fetches the opportunity identified by the object id.
INCLUDE_ERROR
| Name | Default Value | Description | Java Type | MIME Type | Encoding | ||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| Optional. Specify which configuration to use. | |||||||||||
| Id of the object to read. | String | */* | UTF-8 | ||||||||
| Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation. | |||||||||||
| Optional. Application username | String | */* | UTF-8 | ||||||||
| Optional. Application password | String | */* | UTF-8 | ||||||||
| Optional. URL of the SRPS server API | String | */* | UTF-8 | ||||||||
| Optional. Name of the tenant | String | */* | UTF-8 | ||||||||
| Return Type | Description |
|---|---|
| Opportunity | an instance of Opportunity
|
Fetches the Product identified by the object id.
INCLUDE_ERROR
| Name | Default Value | Description | Java Type | MIME Type | Encoding | ||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| Optional. Specify which configuration to use. | |||||||||||
| Id of the object to read. | String | */* | UTF-8 | ||||||||
| Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation. | |||||||||||
| Optional. Application username | String | */* | UTF-8 | ||||||||
| Optional. Application password | String | */* | UTF-8 | ||||||||
| Optional. URL of the SRPS server API | String | */* | UTF-8 | ||||||||
| Optional. Name of the tenant | String | */* | UTF-8 | ||||||||
| Return Type | Description |
|---|---|
| Product | an instance of org.mule.module.servicesource.model.forecast.Product |
Fetches the Quote identified by the object id.
INCLUDE_ERROR
| Name | Default Value | Description | Java Type | MIME Type | Encoding | ||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| Optional. Specify which configuration to use. | |||||||||||
| Id of the object to read. | String | */* | UTF-8 | ||||||||
| Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation. | |||||||||||
| Optional. Application username | String | */* | UTF-8 | ||||||||
| Optional. Application password | String | */* | UTF-8 | ||||||||
| Optional. URL of the SRPS server API | String | */* | UTF-8 | ||||||||
| Optional. Name of the tenant | String | */* | UTF-8 | ||||||||
| Return Type | Description |
|---|---|
| Quote | an instance of org.mule.module.servicesource.model.forecast.Quote |
Fetches the Task identified by the object id.
INCLUDE_ERROR
| Name | Default Value | Description | Java Type | MIME Type | Encoding | ||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| Optional. Specify which configuration to use. | |||||||||||
| Id of the object to read. | String | */* | UTF-8 | ||||||||
| Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation. | |||||||||||
| Optional. Application username | String | */* | UTF-8 | ||||||||
| Optional. Application password | String | */* | UTF-8 | ||||||||
| Optional. URL of the SRPS server API | String | */* | UTF-8 | ||||||||
| Optional. Name of the tenant | String | */* | UTF-8 | ||||||||
| Return Type | Description |
|---|---|
| Task | an instance of org.mule.module.servicesource.model.forecast.Task |
This method provides search capabilities by specifying filters through a map. The advantage of using this processor over query is that you can now use a map to visually add the filters and you don't risk exceeding the max length of the query params since the filters are sent as a post.
INCLUDE_ERROR
| Name | Default Value | Description | Java Type | MIME Type | Encoding | ||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| Optional. Specify which configuration to use. | |||||||||||
| The collection to query | ServiceSourceCollection | */* | |||||||||
| false | Optional. Wheter or not to do streaming | boolean | */* | ||||||||
| 100 | Optional. The max number of results to return. If you want to have no limit then pass -1 | int | */* | ||||||||
| Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation. | |||||||||||
| Optional. Application username | String | */* | UTF-8 | ||||||||
| Optional. Application password | String | */* | UTF-8 | ||||||||
| Optional. URL of the SRPS server API | String | */* | UTF-8 | ||||||||
| Optional. Name of the tenant | String | */* | UTF-8 | ||||||||
| Name | Default Value | Description | Java Type |
|---|---|---|---|
| Optional. Map that includes filters | Map<String, Object> | ||
| Optional. An optional list of columns to return. Use this to only return the fields you're interested while reducing network traffic | List<String> |
| Return Type | Description |
|---|---|
| List<ServiceSourceEntity> | A List of objects that matched the criteria. The actual type of those objects depends on the provided collection
but will be a subclass of ServiceSourceEntity
|
Starts a Data Load by creating an entry in the data load collection. The returned data load object contains an id field and the content of this field must be used in the load and done API call URLs.
INCLUDE_ERROR
| Name | Default Value | Description | Java Type | MIME Type | Encoding | ||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| Optional. Specify which configuration to use. | |||||||||||
| The name of the data load job you want to start | String | */* | UTF-8 | ||||||||
| The id of the data load configuration that this job references to | String | */* | UTF-8 | ||||||||
| A friendly name for the generated job | String | */* | UTF-8 | ||||||||
| Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation. | |||||||||||
| Optional. Application username | String | */* | UTF-8 | ||||||||
| Optional. Application password | String | */* | UTF-8 | ||||||||
| Optional. URL of the SRPS server API | String | */* | UTF-8 | ||||||||
| Optional. Name of the tenant | String | */* | UTF-8 | ||||||||
Generic method to update entities from dynamic collections
INCLUDE_ERROR
| Name | Default Value | Description | Java Type | MIME Type | Encoding | ||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| Optional. Specify which configuration to use. | |||||||||||
A member of the ServiceSourceCollection enum representing the collection that owns the entity |
ServiceSourceCollection | */* | |||||||||
| The id of the entity you want to get | String | */* | UTF-8 | ||||||||
| #[payload] | Optional. A subclass instance of ServiceSourceEntity with the entitie's new state |
ServiceSourceEntity | */* | ||||||||
| Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation. | |||||||||||
| Optional. Application username | String | */* | UTF-8 | ||||||||
| Optional. Application password | String | */* | UTF-8 | ||||||||
| Optional. URL of the SRPS server API | String | */* | UTF-8 | ||||||||
| Optional. Name of the tenant | String | */* | UTF-8 | ||||||||
| Return Type | Description |
|---|---|
| ServiceSourceEntity | a subclass instance of ServiceSourceEntity with the created entity
|
Updates an address
INCLUDE_ERROR
| Name | Default Value | Description | Java Type | MIME Type | Encoding | ||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| Optional. Specify which configuration to use. | |||||||||||
| Id of the object to update. | String | */* | UTF-8 | ||||||||
| #[payload] | Optional. The new state of the note as an instance of Address |
Address | */* | ||||||||
| Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation. | |||||||||||
| Optional. Application username | String | */* | UTF-8 | ||||||||
| Optional. Application password | String | */* | UTF-8 | ||||||||
| Optional. URL of the SRPS server API | String | */* | UTF-8 | ||||||||
| Optional. Name of the tenant | String | */* | UTF-8 | ||||||||
Updates an Asset
INCLUDE_ERROR
| Name | Default Value | Description | Java Type | MIME Type | Encoding | ||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| Optional. Specify which configuration to use. | |||||||||||
| Id of the object to update. | String | */* | UTF-8 | ||||||||
| #[payload] | Optional. The new state of the asset as an instance of Asset |
Asset | */* | ||||||||
| Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation. | |||||||||||
| Optional. Application username | String | */* | UTF-8 | ||||||||
| Optional. Application password | String | */* | UTF-8 | ||||||||
| Optional. URL of the SRPS server API | String | */* | UTF-8 | ||||||||
| Optional. Name of the tenant | String | */* | UTF-8 | ||||||||
Updates a Booking
INCLUDE_ERROR
| Name | Default Value | Description | Java Type | MIME Type | Encoding | ||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| Optional. Specify which configuration to use. | |||||||||||
| Id of the object to update. | String | */* | UTF-8 | ||||||||
| #[payload] | Optional. The new state of the booking as an instance of Booking |
Booking | */* | ||||||||
| Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation. | |||||||||||
| Optional. Application username | String | */* | UTF-8 | ||||||||
| Optional. Application password | String | */* | UTF-8 | ||||||||
| Optional. URL of the SRPS server API | String | */* | UTF-8 | ||||||||
| Optional. Name of the tenant | String | */* | UTF-8 | ||||||||
Updates a given contact
INCLUDE_ERROR
| Name | Default Value | Description | Java Type | MIME Type | Encoding | ||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| Optional. Specify which configuration to use. | |||||||||||
| Id of the object to update. | String | */* | UTF-8 | ||||||||
| #[payload] | Optional. The new state of the contact as an instance of Contact |
Contact | */* | ||||||||
| Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation. | |||||||||||
| Optional. Application username | String | */* | UTF-8 | ||||||||
| Optional. Application password | String | */* | UTF-8 | ||||||||
| Optional. URL of the SRPS server API | String | */* | UTF-8 | ||||||||
| Optional. Name of the tenant | String | */* | UTF-8 | ||||||||
Updates a forecast
INCLUDE_ERROR
| Name | Default Value | Description | Java Type | MIME Type | Encoding | ||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| Optional. Specify which configuration to use. | |||||||||||
| Id of the object to update. | String | */* | UTF-8 | ||||||||
| #[payload] | Optional. The new state of the forecast as an instance of Forecast |
Forecast | */* | ||||||||
| Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation. | |||||||||||
| Optional. Application username | String | */* | UTF-8 | ||||||||
| Optional. Application password | String | */* | UTF-8 | ||||||||
| Optional. URL of the SRPS server API | String | */* | UTF-8 | ||||||||
| Optional. Name of the tenant | String | */* | UTF-8 | ||||||||
Updates a given note
INCLUDE_ERROR
| Name | Default Value | Description | Java Type | MIME Type | Encoding | ||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| Optional. Specify which configuration to use. | |||||||||||
| Id of the no to update. | String | */* | UTF-8 | ||||||||
| #[payload] | Optional. The new state of the note as an instance of Note |
Note | */* | ||||||||
| Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation. | |||||||||||
| Optional. Application username | String | */* | UTF-8 | ||||||||
| Optional. Application password | String | */* | UTF-8 | ||||||||
| Optional. URL of the SRPS server API | String | */* | UTF-8 | ||||||||
| Optional. Name of the tenant | String | */* | UTF-8 | ||||||||
Updates an offer
INCLUDE_ERROR
| Name | Default Value | Description | Java Type | MIME Type | Encoding | ||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| Optional. Specify which configuration to use. | |||||||||||
| Id of the object to update. | String | */* | UTF-8 | ||||||||
| #[payload] | Optional. The new state of the offer as an instance of Offer |
Offer | */* | ||||||||
| Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation. | |||||||||||
| Optional. Application username | String | */* | UTF-8 | ||||||||
| Optional. Application password | String | */* | UTF-8 | ||||||||
| Optional. URL of the SRPS server API | String | */* | UTF-8 | ||||||||
| Optional. Name of the tenant | String | */* | UTF-8 | ||||||||
Updates an opportunity
INCLUDE_ERROR
| Name | Default Value | Description | Java Type | MIME Type | Encoding | ||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| Optional. Specify which configuration to use. | |||||||||||
| Id of the object to update. | String | */* | UTF-8 | ||||||||
| #[payload] | Optional. The new state of the note as an instance of Opportunity |
Opportunity | */* | ||||||||
| Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation. | |||||||||||
| Optional. Application username | String | */* | UTF-8 | ||||||||
| Optional. Application password | String | */* | UTF-8 | ||||||||
| Optional. URL of the SRPS server API | String | */* | UTF-8 | ||||||||
| Optional. Name of the tenant | String | */* | UTF-8 | ||||||||
| Return Type | Description |
|---|---|
| Opportunity | The updated opportunity as an instance of Opportunity
|
Updates a Product
INCLUDE_ERROR
| Name | Default Value | Description | Java Type | MIME Type | Encoding | ||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| Optional. Specify which configuration to use. | |||||||||||
| Id of the object to update. | String | */* | UTF-8 | ||||||||
| #[payload] | Optional. The new state of the product as an instance of Product |
Product | */* | ||||||||
| Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation. | |||||||||||
| Optional. Application username | String | */* | UTF-8 | ||||||||
| Optional. Application password | String | */* | UTF-8 | ||||||||
| Optional. URL of the SRPS server API | String | */* | UTF-8 | ||||||||
| Optional. Name of the tenant | String | */* | UTF-8 | ||||||||
Updates a Quote
INCLUDE_ERROR
| Name | Default Value | Description | Java Type | MIME Type | Encoding | ||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| Optional. Specify which configuration to use. | |||||||||||
| Id of the object to update. | String | */* | UTF-8 | ||||||||
| #[payload] | Optional. The new state of the quote as an instance of Quote |
Quote | */* | ||||||||
| Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation. | |||||||||||
| Optional. Application username | String | */* | UTF-8 | ||||||||
| Optional. Application password | String | */* | UTF-8 | ||||||||
| Optional. URL of the SRPS server API | String | */* | UTF-8 | ||||||||
| Optional. Name of the tenant | String | */* | UTF-8 | ||||||||
Updates a Task
INCLUDE_ERROR
| Name | Default Value | Description | Java Type | MIME Type | Encoding | ||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| Optional. Specify which configuration to use. | |||||||||||
| Id of the object to update. | String | */* | UTF-8 | ||||||||
| #[payload] | Optional. The new state of the task as an instance of Task |
Task | */* | ||||||||
| Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation. | |||||||||||
| Optional. Application username | String | */* | UTF-8 | ||||||||
| Optional. Application password | String | */* | UTF-8 | ||||||||
| Optional. URL of the SRPS server API | String | */* | UTF-8 | ||||||||
| Optional. Name of the tenant | String | */* | UTF-8 | ||||||||