org.mule.modules

mule-module-liquidplanner

config

Namespace	http://www.mulesoft.org/schema/mule/liquidplanner
Schema Location	http://www.mulesoft.org/schema/mule/liquidplanner/current/mule-liquidplanner.xsd (View Schema)
Schema Version	1.0
Minimum Mule Version	3.2

Module Overview

LiquidPlanner is a platform-independent, online project management system which features ranged estimates (e.g. 3–5 days) to express the uncertainty in project schedules.This collaborative software is accessible via modern web-browsers and mobile applications for iPhone, iPad, and Android operating system-based devices.

Summary

Configuration
<liquidplanner:config> Configure an instance of this module

Message Processors
<liquidplanner:create-client> Creates a `Client`
<liquidplanner:create-comment> Creates a `Comment`
<liquidplanner:create-document> Creates a `Document` NOTE: due to unresolved issues in the LiquidPlanner API this message processor is not returning a Java Object.
<liquidplanner:create-event> Creates a `Event`
<liquidplanner:create-folder> Creates a `Folder`
<liquidplanner:create-link> Creates a `Link`
<liquidplanner:create-milestone> Creates particular `Milestone`
<liquidplanner:create-package> Creates a `LPPackage`
<liquidplanner:create-project> Create a new Project
<liquidplanner:create-task> Creates a task
<liquidplanner:delete-client> Deletes a `Client`
<liquidplanner:delete-comment> Deletes a `Comment`
<liquidplanner:delete-document> Deletes a `Document`
<liquidplanner:delete-event> Deletes a `Event`
<liquidplanner:delete-folder> Deletes a `Folder`
<liquidplanner:delete-link> Deletes a `Link`
<liquidplanner:delete-milestone> Deletes a particular `Milestone`
<liquidplanner:delete-package> Deletes a `LPPackage`
<liquidplanner:delete-project> Deletes a particular `Project`
<liquidplanner:delete-task> Deletes a task
<liquidplanner:download-document> Retrieves all the `Document` in the workspace
<liquidplanner:duplicate-project> Duplicates a particular `Project`
<liquidplanner:get-activities> Retrieves all the `Activity` in the workspace
<liquidplanner:get-activity> Retrieves a particular `Activity`
<liquidplanner:get-check-list-item> Retrieves all the `CheckListItem` in the workspace
<liquidplanner:get-check-list-items> Retrieves all the `CheckListItem` in the workspace
<liquidplanner:get-client> Retrieve a particular `Client`
<liquidplanner:get-client-comments> Retrieve all the `Comment` for a particular `Client`
<liquidplanner:get-client-documents> Retrieve all the `Document` for a particular `Client`
<liquidplanner:get-client-estimate> Retrieve a particular `Estimate` for a particular `Client`
<liquidplanner:get-client-estimates> Retrieve all the `Estimate` for a particular `Client`
<liquidplanner:get-client-links> Retrieve all the `Link` for a particular `Client`
<liquidplanner:get-client-note> Retrieve a `Note` for a particular `Client`
<liquidplanner:get-clients> Retrieves all the `Client` in the workspace
<liquidplanner:get-comment> Retrieves a particular `Comment`
<liquidplanner:get-comments> Retrieves all the `Comment` in the workspace
<liquidplanner:get-custom-field> Retrieves a particular `CustomField`
<liquidplanner:get-custom-fields> Retrieves all the `CustomField` in the workspace
<liquidplanner:get-document> Retrieves a particular `Document`
<liquidplanner:get-documents> Retrieves all the `Document` in the workspace
<liquidplanner:get-event> Retrieves a particular `Event`
<liquidplanner:get-event-check-list-items> Retrieves all the `CheckListItem` related to an event
<liquidplanner:get-event-comments> Retrieves all the `Comment` related to an event
<liquidplanner:get-event-documents> Retrieves all the `Document` related to an event
<liquidplanner:get-event-links> Retrieves all the `Link` related to an event
<liquidplanner:get-event-timesheet-entries> Retrieves all the `TimesheetEntry` related to an event
<liquidplanner:get-events> Retrieves all the `Event` in the workspace
<liquidplanner:get-folder> Retrieves a particular `Folder`
<liquidplanner:get-folders> Retrieves all the `Folder` in the workspace
<liquidplanner:get-link> Retrieves a particular `Link`
<liquidplanner:get-links> Retrieves all the `Link` in the workspace
<liquidplanner:get-member> Return a particular member
<liquidplanner:get-members> Return a list of member
<liquidplanner:get-milestone> Retrieves a particular `Milestone`
<liquidplanner:get-milestones> Retrieves all the `Milestone` in the workspace
<liquidplanner:get-package> Retrieves a particular `LPPackage`
<liquidplanner:get-package-comments> Retrieves all the `Comment` for a particular `LPPackage`
<liquidplanner:get-package-dependencies> Retrieves all the `Dependency` for a particular `LPPackage`
<liquidplanner:get-package-documents> Retrieves all the `Document` for a particular `LPPackage`
<liquidplanner:get-package-estimates> Retrieves all the `Estimate` for a particular `LPPackage`
<liquidplanner:get-package-links> Retrieves all the `Link` for a particular `LPPackage`
<liquidplanner:get-package-note> Retrieves all the `Note` for a particular `LPPackage`
<liquidplanner:get-packages> Retrieves all the `LPPackage` in the workspace
<liquidplanner:get-project> Return a particular projects
<liquidplanner:get-project-comments> Return a particular projects
<liquidplanner:get-projects> Return a list of projects
<liquidplanner:get-task> Retrieves a particular tasks in the workspace
<liquidplanner:get-task-timesheet> Retrieves a particular `Timesheet` related to a `Task`
<liquidplanner:get-task-timesheets> Retrieves all the `Timesheet` related to a `Task`
<liquidplanner:get-tasks> Retrieves all the existing tasks in the workspace
<liquidplanner:get-timesheet> Return a time sheets
<liquidplanner:get-timesheet-entries> Return a list of time sheets entries
<liquidplanner:get-timesheet-entry> Return a time sheet entry
<liquidplanner:get-timesheets> Return a list of the time sheets
<liquidplanner:get-tree-items> Get all the Tree items related to a workspace
<liquidplanner:get-work-spaces> Retrieves all the `Workspace` releted to the account
<liquidplanner:get-workspace> Retrieves a particular `Workspace`
<liquidplanner:update-client> Updates a `Client`
<liquidplanner:update-comment> Updates a `Comment`
<liquidplanner:update-document> Updates a `Document`
<liquidplanner:update-event> Updates a `Event`
<liquidplanner:update-folder> Updates a `Folder`
<liquidplanner:update-link> Updates a `Link`
<liquidplanner:update-milestone> Updates a particular `Milestone`
<liquidplanner:update-package> Updates a `LPPackage`
<liquidplanner:update-project> Updates a particular `Project`
<liquidplanner:update-task> Updates a task

Configuration

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:liquidplanner="http://www.mulesoft.org/schema/mule/liquidplanner"
      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/liquidplanner
               http://www.mulesoft.org/schema/mule/liquidplanner/current/mule-liquidplanner.xsd">

      <!-- here goes your flows and configuration elements -->

</mule>

Connection Pool

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:

    <liquidplanner: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
config-ref		Optional. Specify which configuration to use.
username		A username	String	/	UTF-8
password		A password	String	/	UTF-8

Reconnection Strategies

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:

The type of exception
Number and frequency of reconnection attempts
The notifications generated, and more

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.

Configuration

A reconnection strategy that allows the user to configure how many times a reconnection should be attempted and how long to wait between attempts.

    <liquidplanner:config>
         <reconnect count="5" frequency="1000"/>
    </liquidplanner:config>

Reconnect Attributes
Name	Default Value	Description
frequency	2000	Optional. How often (in ms) to reconnect
count	2	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.

Message Processors

<liquidplanner:create-client>

Creates a Client

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
workSpaceId	The id of the workspace	String	/	UTF-8
client	The the client	Client	/
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.
username	Optional. A username	String	/	UTF-8
password	Optional. A password	String	/	UTF-8

Returns

Return Type	Description
Client	the `Client` created

<liquidplanner:create-comment>

Creates a Comment

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
workSpaceId	The id of the workspace	String	/	UTF-8
comment	The comment to be created	Comment	/
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.
username	Optional. A username	String	/	UTF-8
password	Optional. A password	String	/	UTF-8

Returns

Return Type	Description
Comment	the `Comment` created

<liquidplanner:create-document>

Creates a Document NOTE: due to unresolved issues in the LiquidPlanner API this message processor is not returning a Java Object. Instead the processor is returning a String which is the JSON representation of the object that the LiquidPlanner API is actually returning.

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
workSpaceId	The id of the workspace	String	/	UTF-8
entity	The type to which the document should be created against	ServiceEntity	/
entityId	The id of the entity	String	/	UTF-8
fileName	The name of the file to assign to the document	String	/	UTF-8
fileDescription	A description for the document @ fileInputStream the	String	/	UTF-8
fileInputStream	For the document to be uploaded	InputStream	/
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.
username	Optional. A username	String	/	UTF-8
password	Optional. A password	String	/	UTF-8

Returns

Return Type	Description
String	a string representation of the document

<liquidplanner:create-event>

Creates a Event

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
workSpaceId	The id of the workspace	String	/	UTF-8
event	The event	Event	/
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.
username	Optional. A username	String	/	UTF-8
password	Optional. A password	String	/	UTF-8

Returns

Return Type	Description
Event	the `Event` created

<liquidplanner:create-folder>

Creates a Folder

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
workSpaceId	The id of the workspace	String	/	UTF-8
folder	The `Folder` to be created	Folder	/
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.
username	Optional. A username	String	/	UTF-8
password	Optional. A password	String	/	UTF-8

Returns

Return Type	Description
Folder	the `Folder` created

<liquidplanner:create-link>

Creates a Link

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
workSpaceId	The id of the workspace	String	/	UTF-8
link	The link to be created	Link	/
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.
username	Optional. A username	String	/	UTF-8
password	Optional. A password	String	/	UTF-8

Returns

Return Type	Description
Link	the `Link` created

<liquidplanner:create-milestone>

Creates particular Milestone

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
workSpaceId	The id of the workspace	String	/	UTF-8
milestone	The `Milestone`	Milestone	/
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.
username	Optional. A username	String	/	UTF-8
password	Optional. A password	String	/	UTF-8

Returns

Return Type	Description
Milestone	the `Milestone` created

<liquidplanner:create-package>

Creates a LPPackage

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
workSpaceId	The id of the workspace	String	/	UTF-8
aPackage	The `LPPackage` to be created	LPPackage	/
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.
username	Optional. A username	String	/	UTF-8
password	Optional. A password	String	/	UTF-8

Returns

Return Type	Description
LPPackage	the `LPPackage` created

<liquidplanner:create-project>

Create a new Project

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
workSpaceId	The id of the workspace	String	/	UTF-8
project	The project entity you're trying to create	Project	/
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.
username	Optional. A username	String	/	UTF-8
password	Optional. A password	String	/	UTF-8

Returns

Return Type	Description
Project	a `Project`

<liquidplanner:create-task>

Creates a task

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
workSpaceId	The id of the workspace	String	/	UTF-8
task	The `Task` to be created	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.
username	Optional. A username	String	/	UTF-8
password	Optional. A password	String	/	UTF-8

Returns

Return Type	Description
Task	the `Task` created

<liquidplanner:delete-client>

Deletes a Client

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
workSpaceId	The id of the workspace	String	/	UTF-8
id	The id of the client	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.
username	Optional. A username	String	/	UTF-8
password	Optional. A password	String	/	UTF-8

Returns

Return Type	Description
Client	the `Client` deleted

<liquidplanner:delete-comment>

Deletes a Comment

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
workSpaceId	The id of the workspace	String	/	UTF-8
commentId	The id of the comment	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.
username	Optional. A username	String	/	UTF-8
password	Optional. A password	String	/	UTF-8

Returns

Return Type	Description
Comment	the `Comment` deleted

<liquidplanner:delete-document>

Deletes a Document

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
workSpaceId	The id of the workspace	String	/	UTF-8
id	The id of the document to be deleted	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.
username	Optional. A username	String	/	UTF-8
password	Optional. A password	String	/	UTF-8

Returns

Return Type	Description
Document	the `Document` deleted

<liquidplanner:delete-event>

Deletes a Event

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
workSpaceId	The id of the workspace	String	/	UTF-8
id	The id of event	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.
username	Optional. A username	String	/	UTF-8
password	Optional. A password	String	/	UTF-8

Returns

Return Type	Description
Event	the `Event` deleted

<liquidplanner:delete-folder>

Deletes a Folder

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
workSpaceId	The id of the workspace	String	/	UTF-8
id	The id of the `Folder` to be deleted	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.
username	Optional. A username	String	/	UTF-8
password	Optional. A password	String	/	UTF-8

Returns

Return Type	Description
Folder	the `Folder` deleted

<liquidplanner:delete-link>

Deletes a Link

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
workSpaceId	The id of the workspace	String	/	UTF-8
id	The id of the link to be deleted	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.
username	Optional. A username	String	/	UTF-8
password	Optional. A password	String	/	UTF-8

Returns

Return Type	Description
Link	the `Link` deleted

<liquidplanner:delete-milestone>

Deletes a particular Milestone

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
workSpaceId	The id of the workspace	String	/	UTF-8
id	The id of the `Milestone`	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.
username	Optional. A username	String	/	UTF-8
password	Optional. A password	String	/	UTF-8

Returns

Return Type	Description
Milestone	the `Milestone` deleted

<liquidplanner:delete-package>

Deletes a LPPackage

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
workSpaceId	The id of the workspace	String	/	UTF-8
id	The id of the `LPPackage` to be updated	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.
username	Optional. A username	String	/	UTF-8
password	Optional. A password	String	/	UTF-8

Returns

Return Type	Description
LPPackage	the `LPPackage` deleted

<liquidplanner:delete-project>

Deletes a particular Project

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
workSpaceId	The id of the workspace	String	/	UTF-8
id	The project id 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.
username	Optional. A username	String	/	UTF-8
password	Optional. A password	String	/	UTF-8

Returns

Return Type	Description
Project	the deleted `Project`

<liquidplanner:delete-task>

Deletes a task

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
workSpaceId	The id of the workspace	String	/	UTF-8
taskId	The id of the `Task` to be deleted	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.
username	Optional. A username	String	/	UTF-8
password	Optional. A password	String	/	UTF-8

Returns

Return Type	Description
Task	the `Task` deleted

<liquidplanner:download-document>

Retrieves all the Document in the workspace

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
workSpaceId	The id of the workspace	String	/	UTF-8
documentId	The id of the document	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.
username	Optional. A username	String	/	UTF-8
password	Optional. A password	String	/	UTF-8

Returns

Return Type	Description
InputStream	the input stream for the actual document represented by a `Document`

<liquidplanner:duplicate-project>

Duplicates a particular Project

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
workSpaceId	The id of the workspace	String	/	UTF-8
sourceProjectId	The id of the source project	String	/	UTF-8
destinationParentId	The id of the parent destination	String	/	UTF-8
newProjectName	The name of the new project	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.
username	Optional. A username	String	/	UTF-8
password	Optional. A password	String	/	UTF-8

Returns

Return Type	Description
Project	the created `Project`

<liquidplanner:get-activities>

Retrieves all the Activity in the workspace

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
workSpaceId	The id of the workspace	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.
username	Optional. A username	String	/	UTF-8
password	Optional. A password	String	/	UTF-8

Returns

Return Type	Description
List<Activity>	a list of `Activity`

<liquidplanner:get-activity>

Retrieves a particular Activity

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
workSpaceId	The id of the workspace	String	/	UTF-8
activityId	The id of the activity	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.
username	Optional. A username	String	/	UTF-8
password	Optional. A password	String	/	UTF-8

Returns

Return Type	Description
Activity	the `Activity`

<liquidplanner:get-check-list-item>

Retrieves all the CheckListItem in the workspace

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
workSpaceId	The id of the workspace	String	/	UTF-8
checkListItemId	The id of the checklistitem	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.
username	Optional. A username	String	/	UTF-8
password	Optional. A password	String	/	UTF-8

Returns

Return Type	Description
CheckListItem	a list of `CheckListItem`

<liquidplanner:get-check-list-items>

Retrieves all the CheckListItem in the workspace

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
workSpaceId	The id of the workspace	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.
username	Optional. A username	String	/	UTF-8
password	Optional. A password	String	/	UTF-8

Returns

Return Type	Description
List<CheckListItem>	a list of `CheckListItem`

<liquidplanner:get-client>

Retrieve a particular Client

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
workSpaceId	The id of the workspace	String	/	UTF-8
clientId	The id of the client	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.
username	Optional. A username	String	/	UTF-8
password	Optional. A password	String	/	UTF-8

Returns

Return Type	Description
Client	a `Client`

<liquidplanner:get-client-comments>

Retrieve all the Comment for a particular Client

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
workSpaceId	The id of the workspace	String	/	UTF-8
clientId	The id of the client	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.
username	Optional. A username	String	/	UTF-8
password	Optional. A password	String	/	UTF-8

Returns

Return Type	Description
List<Comment>	a list of `Comment`

<liquidplanner:get-client-documents>

Retrieve all the Document for a particular Client

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
workSpaceId	The id of the workspace	String	/	UTF-8
clientId	The id of the client	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.
username	Optional. A username	String	/	UTF-8
password	Optional. A password	String	/	UTF-8

Returns

Return Type	Description
List<Document>	a list of `Document`

<liquidplanner:get-client-estimate>

Retrieve a particular Estimate for a particular Client

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
workSpaceId	The id of the workspace	String	/	UTF-8
clientId	The id of the client	String	/	UTF-8
estimateId	The id of the estimate	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.
username	Optional. A username	String	/	UTF-8
password	Optional. A password	String	/	UTF-8

Returns

Return Type	Description
Estimate	a `Estimate`

<liquidplanner:get-client-estimates>

Retrieve all the Estimate for a particular Client

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
workSpaceId	The id of the workspace	String	/	UTF-8
clientId	The id of the client	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.
username	Optional. A username	String	/	UTF-8
password	Optional. A password	String	/	UTF-8

Returns

Return Type	Description
List<Estimate>	a list of `Estimate`

<liquidplanner:get-client-links>

Retrieve all the Link for a particular Client

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
workSpaceId	The id of the workspace	String	/	UTF-8
clientId	The id of the client	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.
username	Optional. A username	String	/	UTF-8
password	Optional. A password	String	/	UTF-8

Returns

Return Type	Description
List<Link>	a list of `Link`

<liquidplanner:get-client-note>

Retrieve a Note for a particular Client

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
workSpaceId	The id of the workspace	String	/	UTF-8
clientId	The id of the client	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.
username	Optional. A username	String	/	UTF-8
password	Optional. A password	String	/	UTF-8

Returns

Return Type	Description
Note	a `Note`

<liquidplanner:get-clients>

Retrieves all the Client in the workspace

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
workSpaceId	The id of the workspace	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.
username	Optional. A username	String	/	UTF-8
password	Optional. A password	String	/	UTF-8

Returns

Return Type	Description
List<Client>	a list of `Client`

<liquidplanner:get-comment>

Retrieves a particular Comment

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
workSpaceId	The id of the workspace	String	/	UTF-8
commentId	The id of the comment	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.
username	Optional. A username	String	/	UTF-8
password	Optional. A password	String	/	UTF-8

Returns

Return Type	Description
Comment	a `Comment`

<liquidplanner:get-comments>

Retrieves all the Comment in the workspace

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
workSpaceId	The id of the workspace	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.
username	Optional. A username	String	/	UTF-8
password	Optional. A password	String	/	UTF-8

Returns

Return Type	Description
List<Comment>	a list of `Comment`

<liquidplanner:get-custom-field>

Retrieves a particular CustomField

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
workSpaceId	The id of the workspace	String	/	UTF-8
customFieldId	The id of the custom field	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.
username	Optional. A username	String	/	UTF-8
password	Optional. A password	String	/	UTF-8

Returns

Return Type	Description
CustomField	a `CustomField`

<liquidplanner:get-custom-fields>

Retrieves all the CustomField in the workspace

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
workSpaceId	The id of the workspace	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.
username	Optional. A username	String	/	UTF-8
password	Optional. A password	String	/	UTF-8

Returns

Return Type	Description
List<CustomField>	a list of `CustomField`

<liquidplanner:get-document>

Retrieves a particular Document

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
workSpaceId	The id of the workspace	String	/	UTF-8
documentId	The id of the document	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.
username	Optional. A username	String	/	UTF-8
password	Optional. A password	String	/	UTF-8

Returns

Return Type	Description
Document	a `Document`

<liquidplanner:get-documents>

Retrieves all the Document in the workspace

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
workSpaceId	The id of the workspace	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.
username	Optional. A username	String	/	UTF-8
password	Optional. A password	String	/	UTF-8

Returns

Return Type	Description
List<Document>	a list of `Document`

<liquidplanner:get-event>

Retrieves a particular Event

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
workSpaceId	The id of the workspace	String	/	UTF-8
eventId	The id of the event	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.
username	Optional. A username	String	/	UTF-8
password	Optional. A password	String	/	UTF-8

Returns

Return Type	Description
Event	a `Event`

<liquidplanner:get-event-check-list-items>

Retrieves all the CheckListItem related to an event

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
workSpaceId	The id of the workspace	String	/	UTF-8
eventId	The id of the event	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.
username	Optional. A username	String	/	UTF-8
password	Optional. A password	String	/	UTF-8

Returns

Return Type	Description
List<CheckListItem>	a list of `CheckListItem`

<liquidplanner:get-event-comments>

Retrieves all the Comment related to an event

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
workSpaceId	The id of the workspace	String	/	UTF-8
eventId	The id of the event	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.
username	Optional. A username	String	/	UTF-8
password	Optional. A password	String	/	UTF-8

Returns

Return Type	Description
List<Comment>	a list of `Comment`

<liquidplanner:get-event-documents>

Retrieves all the Document related to an event

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
workSpaceId	The id of the workspace	String	/	UTF-8
eventId	The id of the event	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.
username	Optional. A username	String	/	UTF-8
password	Optional. A password	String	/	UTF-8

Returns

Return Type	Description
List<Document>	a list of `Document`

<liquidplanner:get-event-links>

Retrieves all the Link related to an event

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
workSpaceId	The id of the workspace	String	/	UTF-8
eventId	The id of the event	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.
username	Optional. A username	String	/	UTF-8
password	Optional. A password	String	/	UTF-8

Returns

Return Type	Description
List<Link>	a list of `Link`

<liquidplanner:get-event-timesheet-entries>

Retrieves all the TimesheetEntry related to an event

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
workSpaceId	The id of the workspace	String	/	UTF-8
eventId	The id of the event	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.
username	Optional. A username	String	/	UTF-8
password	Optional. A password	String	/	UTF-8

Returns

Return Type	Description
List<TimesheetEntry>	a list of `TimesheetEntry`

<liquidplanner:get-events>

Retrieves all the Event in the workspace

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
workSpaceId	The id of the workspace	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.
username	Optional. A username	String	/	UTF-8
password	Optional. A password	String	/	UTF-8

Returns

Return Type	Description
List<Event>	a list of `Event`

<liquidplanner:get-folder>

Retrieves a particular Folder

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
workSpaceId	The id of the workspace	String	/	UTF-8
folderId	The id of the folder	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.
username	Optional. A username	String	/	UTF-8
password	Optional. A password	String	/	UTF-8

Returns

Return Type	Description
Folder	a `Folder`

<liquidplanner:get-folders>

Retrieves all the Folder in the workspace

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
workSpaceId	The id of the workspace	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.
username	Optional. A username	String	/	UTF-8
password	Optional. A password	String	/	UTF-8

Returns

Return Type	Description
List<Folder>	a list of `Folder`

<liquidplanner:get-link>

Retrieves a particular Link

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
workSpaceId	The id of the workspace	String	/	UTF-8
linkId	The id of the link	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.
username	Optional. A username	String	/	UTF-8
password	Optional. A password	String	/	UTF-8

Returns

Return Type	Description
Link	a `Link`

<liquidplanner:get-links>

Retrieves all the Link in the workspace

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
workSpaceId	The id of the workspace	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.
username	Optional. A username	String	/	UTF-8
password	Optional. A password	String	/	UTF-8

Returns

Return Type	Description
List<Link>	a list of `Link`

<liquidplanner:get-member>

Return a particular member

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
workSpaceId	The id of the workspace	String	/	UTF-8
memberId	The id of the member you are looking for	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.
username	Optional. A username	String	/	UTF-8
password	Optional. A password	String	/	UTF-8

Returns

Return Type	Description
Member	a JSON string representing the member

<liquidplanner:get-members>

Return a list of member

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
workSpaceId	Content to be processed	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.
username	Optional. A username	String	/	UTF-8
password	Optional. A password	String	/	UTF-8

Returns

Return Type	Description
List<Member>	a JSON string representing a list of members

<liquidplanner:get-milestone>

Retrieves a particular Milestone

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
workSpaceId	The id of the workspace	String	/	UTF-8
milestoneId	The id of the milestone	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.
username	Optional. A username	String	/	UTF-8
password	Optional. A password	String	/	UTF-8

Returns

Return Type	Description
Milestone	the `Milestone`

<liquidplanner:get-milestones>

Retrieves all the Milestone in the workspace

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
workSpaceId	The id of the workspace	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.
username	Optional. A username	String	/	UTF-8
password	Optional. A password	String	/	UTF-8

Returns

Return Type	Description
List<Milestone>	a list of `Milestone`

<liquidplanner:get-package>

Retrieves a particular LPPackage

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
workSpaceId	The id of the workspace	String	/	UTF-8
packageId	The id of the package	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.
username	Optional. A username	String	/	UTF-8
password	Optional. A password	String	/	UTF-8

Returns

Return Type	Description
LPPackage	the `LPPackage`

<liquidplanner:get-package-comments>

Retrieves all the Comment for a particular LPPackage

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
workSpaceId	The id of the workspace	String	/	UTF-8
packageId	The id of the package	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.
username	Optional. A username	String	/	UTF-8
password	Optional. A password	String	/	UTF-8

Returns

Return Type	Description
List<Comment>	a list of `Comment`

<liquidplanner:get-package-dependencies>

Retrieves all the Dependency for a particular LPPackage

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
workSpaceId	The id of the workspace	String	/	UTF-8
packageId	The id of the package	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.
username	Optional. A username	String	/	UTF-8
password	Optional. A password	String	/	UTF-8

Returns

Return Type	Description
List<Dependency>	a list of `Dependency`

<liquidplanner:get-package-documents>

Retrieves all the Document for a particular LPPackage

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
workSpaceId	The id of the workspace	String	/	UTF-8
packageId	The id of the package	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.
username	Optional. A username	String	/	UTF-8
password	Optional. A password	String	/	UTF-8

Returns

Return Type	Description
List<Document>	a list of `Document`

<liquidplanner:get-package-estimates>

Retrieves all the Estimate for a particular LPPackage

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
workSpaceId	The id of the workspace	String	/	UTF-8
packageId	The id of the package	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.
username	Optional. A username	String	/	UTF-8
password	Optional. A password	String	/	UTF-8

Returns

Return Type	Description
List<Estimate>	a list of `Estimate`

<liquidplanner:get-package-links>

Retrieves all the Link for a particular LPPackage

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
workSpaceId	The id of the workspace	String	/	UTF-8
packageId	The id of the package	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.
username	Optional. A username	String	/	UTF-8
password	Optional. A password	String	/	UTF-8

Returns

Return Type	Description
List<Link>	a list of `Link`

<liquidplanner:get-package-note>

Retrieves all the Note for a particular LPPackage

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
workSpaceId	The id of the workspace	String	/	UTF-8
packageId	The id of the package	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.
username	Optional. A username	String	/	UTF-8
password	Optional. A password	String	/	UTF-8

Returns

Return Type	Description
List<Note>	a list of `Note`

<liquidplanner:get-packages>

Retrieves all the LPPackage in the workspace

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
workSpaceId	The id of the workspace	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.
username	Optional. A username	String	/	UTF-8
password	Optional. A password	String	/	UTF-8

Child Elements

Name	Default Value	Description	Java Type
<liquidplanner:filters>		Optional. A list of `Filter` to be applied to the search	List<Filter>

Returns

Return Type	Description
List<LPPackage>	a list of `LPPackage`

<liquidplanner:get-project>

Return a particular projects

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
workSpaceId	The id of the workspace	String	/	UTF-8
projectId	The id of the project you are looking for	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.
username	Optional. A username	String	/	UTF-8
password	Optional. A password	String	/	UTF-8

Returns

Return Type	Description
Project	a JSON string representing the member

<liquidplanner:get-project-comments>

Return a particular projects

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
workSpaceId	The id of the workspace	String	/	UTF-8
projectId	The id of the project you are looking for	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.
username	Optional. A username	String	/	UTF-8
password	Optional. A password	String	/	UTF-8

Returns

Return Type	Description
List<Comment>	a JSON string representing the project comments

<liquidplanner:get-projects>

Return a list of projects

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
workSpaceId	The id of the workspace	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.
username	Optional. A username	String	/	UTF-8
password	Optional. A password	String	/	UTF-8

Returns

Return Type	Description
List<Project>	a JSON string representing list of projects member

<liquidplanner:get-task>

Retrieves a particular tasks in the workspace

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
workSpaceId	The id of the workspace	String	/	UTF-8
taskId	The id of the `Task` to retrieve	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.
username	Optional. A username	String	/	UTF-8
password	Optional. A password	String	/	UTF-8

Returns

Return Type	Description
Task	the `Task`

<liquidplanner:get-task-timesheet>

Retrieves a particular Timesheet related to a Task

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
workSpaceId	The id of the workspace	String	/	UTF-8
taskId	The id of the `Task` to be deleted	String	/	UTF-8
timesheetId	The id of the `Timesheet`	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.
username	Optional. A username	String	/	UTF-8
password	Optional. A password	String	/	UTF-8

Returns

Return Type	Description
Timesheet	the `Timesheet`

<liquidplanner:get-task-timesheets>

Retrieves all the Timesheet related to a Task

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
workSpaceId	The id of the workspace	String	/	UTF-8
taskId	The id of the `Task` to be deleted	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.
username	Optional. A username	String	/	UTF-8
password	Optional. A password	String	/	UTF-8

Child Elements

Name	Default Value	Description	Java Type
<liquidplanner:filters>		Optional. A list of `Filter` to be apply to the search	List<Filter>

Returns

Return Type	Description
List<Timesheet>	a list of `Timesheet`

<liquidplanner:get-tasks>

Retrieves all the existing tasks in the workspace

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
workSpaceId	The id of the workspace	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.
username	Optional. A username	String	/	UTF-8
password	Optional. A password	String	/	UTF-8

Child Elements

Name	Default Value	Description	Java Type
<liquidplanner:filters>		Optional. The list of `Filter` to run through the search	List<Filter>

Returns

Return Type	Description
List<Task>	the list of `Task`

<liquidplanner:get-timesheet>

Return a time sheets

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
workSpaceId	Content to be processed	String	/	UTF-8
timesheetId	The id of the timesheet	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.
username	Optional. A username	String	/	UTF-8
password	Optional. A password	String	/	UTF-8

Returns

Return Type	Description
Timesheet	Some string

<liquidplanner:get-timesheet-entries>

Return a list of time sheets entries

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
workSpaceId	Content to be processed	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.
username	Optional. A username	String	/	UTF-8
password	Optional. A password	String	/	UTF-8

Child Elements

Name	Default Value	Description	Java Type
<liquidplanner:filters>		Optional. The list of `Filter` to run through the search	List<Filter>

Returns

Return Type	Description
List<TimesheetEntry>	Some string

<liquidplanner:get-timesheet-entry>

Return a time sheet entry

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
workSpaceId	Content to be processed	String	/	UTF-8
timesheetEntryId	The id of the timesheet entry	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.
username	Optional. A username	String	/	UTF-8
password	Optional. A password	String	/	UTF-8

Returns

Return Type	Description
TimesheetEntry	Some string

<liquidplanner:get-timesheets>

Return a list of the time sheets

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
workSpaceId	Content to be processed	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.
username	Optional. A username	String	/	UTF-8
password	Optional. A password	String	/	UTF-8

Child Elements

Name	Default Value	Description	Java Type
<liquidplanner:filters>		Optional. The list of `Filter` to run through the search	List<Filter>

Returns

Return Type	Description
List<Timesheet>	Some string

<liquidplanner:get-tree-items>

Get all the Tree items related to a workspace

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
workSpaceId	The id of the workspace	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.
username	Optional. A username	String	/	UTF-8
password	Optional. A password	String	/	UTF-8

Returns

Return Type	Description
String	a `TreeItem` list

<liquidplanner:get-work-spaces>

Retrieves all the Workspace releted to the account

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
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.
username	Optional. A username	String	/	UTF-8
password	Optional. A password	String	/	UTF-8

Returns

Return Type	Description
List<Workspace>	the `Workspace` deleted

<liquidplanner:get-workspace>

Retrieves a particular Workspace

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
workSpaceId	The id of the workspace	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.
username	Optional. A username	String	/	UTF-8
password	Optional. A password	String	/	UTF-8

Returns

Return Type	Description
Workspace	the `Workspace`

<liquidplanner:update-client>

Updates a Client

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
workSpaceId	The id of the workspace	String	/	UTF-8
client	The the client	Client	/
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.
username	Optional. A username	String	/	UTF-8
password	Optional. A password	String	/	UTF-8

Returns

Return Type	Description
Client	the `Client` updated

<liquidplanner:update-comment>

Updates a Comment

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
workSpaceId	The id of the workspace	String	/	UTF-8
comment	The comment to be updated	Comment	/
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.
username	Optional. A username	String	/	UTF-8
password	Optional. A password	String	/	UTF-8

Returns

Return Type	Description
Comment	the `Comment` updated

<liquidplanner:update-document>

Updates a Document

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
workSpaceId	The id of the workspace	String	/	UTF-8
document	The `Document` to be updated	Document	/
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.
username	Optional. A username	String	/	UTF-8
password	Optional. A password	String	/	UTF-8

Returns

Return Type	Description
Document	the `Document` updated

<liquidplanner:update-event>

Updates a Event

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
workSpaceId	The id of the workspace	String	/	UTF-8
event	The event	Event	/
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.
username	Optional. A username	String	/	UTF-8
password	Optional. A password	String	/	UTF-8

Returns

Return Type	Description
Event	the `Event` updated

<liquidplanner:update-folder>

Updates a Folder

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
workSpaceId	The id of the workspace	String	/	UTF-8
folder	The `Folder` to be updated	Folder	/
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.
username	Optional. A username	String	/	UTF-8
password	Optional. A password	String	/	UTF-8

Returns

Return Type	Description
Folder	the `Folder` updated

<liquidplanner:update-link>

Updates a Link

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
workSpaceId	The id of the workspace	String	/	UTF-8
link	The link to be updated	Link	/
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.
username	Optional. A username	String	/	UTF-8
password	Optional. A password	String	/	UTF-8

Returns

Return Type	Description
Link	the `Link` updated

<liquidplanner:update-milestone>

Updates a particular Milestone

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
workSpaceId	The id of the workspace	String	/	UTF-8
milestone	The `Milestone`	Milestone	/
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.
username	Optional. A username	String	/	UTF-8
password	Optional. A password	String	/	UTF-8

Returns

Return Type	Description
Milestone	the `Milestone` updated

<liquidplanner:update-package>

Updates a LPPackage

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
workSpaceId	The id of the workspace	String	/	UTF-8
lpPackage	The `LPPackage` to be updated	LPPackage	/
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.
username	Optional. A username	String	/	UTF-8
password	Optional. A password	String	/	UTF-8

Returns

Return Type	Description
LPPackage	the `LPPackage` updated

<liquidplanner:update-project>

Updates a particular Project

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
workSpaceId	The id of the workspace	String	/	UTF-8
project	The project to update	Project	/
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.
username	Optional. A username	String	/	UTF-8
password	Optional. A password	String	/	UTF-8

Returns

Return Type	Description
Project	the updated `Project`

<liquidplanner:update-task>

Updates a task

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
workSpaceId	The id of the workspace	String	/	UTF-8
task	The `Task` to be updated	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.
username	Optional. A username	String	/	UTF-8
password	Optional. A password	String	/	UTF-8

Returns

Return Type	Description
Task	the `Task` updated