org.mule.modules

mule-module-clarizen

config

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

Module Overview

Clarizen Cloud Connector Clarizen project management software is a leading global provider of collaborative online project management that allows businesses to easily manage all of their projects and resources in a single environment. For futher information visit http://www.clarizen.com

Summary

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

Message Processors
<clarizen:attach-file-url-to-entity> Attaches a file to an entity, given that the file resides in an external storage and can be accessed via a URL.
<clarizen:create-entity> Creates a new Clarizen entity
<clarizen:create-from-template> Creates milestones and projects from templates
<clarizen:create-generic-entity> Creates a new Clarizen generic entity
<clarizen:delete-entity> Deletes an entity
<clarizen:delete-entity-by-id> Deletes an entity by its entity Id
<clarizen:describe-entities> Returns the description of an entity
<clarizen:download-entity-attachments> Given a certain Entity Id, retrieves all associated attachments.
<clarizen:download-file-information> Download file information
<clarizen:entity-query> Create an entity query
<clarizen:get-calendar-information> Gets calendar information for the specified user
<clarizen:get-my-work-items> Returns the work items for the current user
<clarizen:get-system-settings> Gets system settings values
<clarizen:get-work-item-by-id> Retrieves a workitem by id.
<clarizen:issue-query> Create an issues query
<clarizen:lifecycle-change> Performs lifecycle changes on an entity or a group of entities
<clarizen:list-entities> Returns the list of entities
<clarizen:retrieve-work-item-human-resources> Given a certain Entity Id representing a work item, retrieves all associated human resources.
<clarizen:send-email> Sends an email to the specified recipients
<clarizen:update-entity> Updates a new Clarizen entity
<clarizen:update-generic-entity> Updates a Clarizen generic entity
<clarizen:work-items-query> Search for work items

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

    <clarizen: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.
connectionUser		The user login user	String	/	UTF-8
connectionPassword		The user login pass	String	/	UTF-8
applicationId		Optional. The id of a specific partner application that can be used for licensing purposed	String	/	UTF-8
partnerId		Optional. The id of a Clarizen partner	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.

    <clarizen:config>
         <reconnect count="5" frequency="1000"/>
    </clarizen: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

<clarizen:attach-file-url-to-entity>

Attaches a file to an entity, given that the file resides in an external storage and can be accessed via a URL.

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
entityId	ID of the entity to which the file URL will be attached	EntityId	/
attachmentUrl	URL pointing to the attachment	String	/	UTF-8
attachmentFilename	Filename of the attachment	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.
connectionUser	Optional. The user login user	String	/	UTF-8
connectionPassword	Optional. The user login pass	String	/	UTF-8
applicationId	Optional. The id of a specific partner application that can be used for licensing purposed	String	/	UTF-8
partnerId	Optional. The id of a Clarizen partner	String	/	UTF-8

Returns

Return Type	Description
Boolean	true if the action was successful

<clarizen:create-entity>

Creates a new Clarizen entity

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
entity	#[payload]	Optional. Entity to be created	BaseClarizenEntity	/
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.
connectionUser		Optional. The user login user	String	/	UTF-8
connectionPassword		Optional. The user login pass	String	/	UTF-8
applicationId		Optional. The id of a specific partner application that can be used for licensing purposed	String	/	UTF-8
partnerId		Optional. The id of a Clarizen partner	String	/	UTF-8

Returns

Return Type	Description
BaseClarizenEntity	Created entity

<clarizen:create-from-template>

Creates milestones and projects from templates

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
templateName		Template to be used	String	/	UTF-8
entity	#[payload]	Optional. Entity to be created from template	BaseClarizenEntity	/
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.
connectionUser		Optional. The user login user	String	/	UTF-8
connectionPassword		Optional. The user login pass	String	/	UTF-8
applicationId		Optional. The id of a specific partner application that can be used for licensing purposed	String	/	UTF-8
partnerId		Optional. The id of a Clarizen partner	String	/	UTF-8

Returns

Return Type	Description
BaseClarizenEntity	created entity

<clarizen:create-generic-entity>

Creates a new Clarizen generic entity

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
entity	#[payload]	Optional. Entity to be created	GenericEntity	/
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.
connectionUser		Optional. The user login user	String	/	UTF-8
connectionPassword		Optional. The user login pass	String	/	UTF-8
applicationId		Optional. The id of a specific partner application that can be used for licensing purposed	String	/	UTF-8
partnerId		Optional. The id of a Clarizen partner	String	/	UTF-8

Returns

Return Type	Description
GenericEntity	Created entity

<clarizen:delete-entity>

Deletes an entity

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
entity	#[payload]	Optional. The entity to be deleted	BaseClarizenEntity	/
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.
connectionUser		Optional. The user login user	String	/	UTF-8
connectionPassword		Optional. The user login pass	String	/	UTF-8
applicationId		Optional. The id of a specific partner application that can be used for licensing purposed	String	/	UTF-8
partnerId		Optional. The id of a Clarizen partner	String	/	UTF-8

Returns

Return Type	Description
Boolean	true if the entity was successfully deleted

<clarizen:delete-entity-by-id>

Deletes an entity by its entity Id

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
entityId	#[payload]	Optional. The entity Id of the entity to be deleted	EntityId	/
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.
connectionUser		Optional. The user login user	String	/	UTF-8
connectionPassword		Optional. The user login pass	String	/	UTF-8
applicationId		Optional. The id of a specific partner application that can be used for licensing purposed	String	/	UTF-8
partnerId		Optional. The id of a Clarizen partner	String	/	UTF-8

Returns

Return Type	Description
Boolean	true if the entity was successfully deleted

<clarizen:describe-entities>

Returns the description of an entity

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.
connectionUser	Optional. The user login user	String	/	UTF-8
connectionPassword	Optional. The user login pass	String	/	UTF-8
applicationId	Optional. The id of a specific partner application that can be used for licensing purposed	String	/	UTF-8
partnerId	Optional. The id of a Clarizen partner	String	/	UTF-8

Child Elements

Name	Default Value	Description	Java Type
<clarizen:type-names>	#[payload]	Optional. List of entity types to be described	List<String>

Returns

Return Type	Description
List<EntityDescription>	`EntityDescription` Entity description

<clarizen:download-entity-attachments>

Given a certain Entity Id, retrieves all associated attachments.

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
entityId	The entity Id associated with the attachments	EntityId	/
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.
connectionUser	Optional. The user login user	String	/	UTF-8
connectionPassword	Optional. The user login pass	String	/	UTF-8
applicationId	Optional. The id of a specific partner application that can be used for licensing purposed	String	/	UTF-8
partnerId	Optional. The id of a Clarizen partner	String	/	UTF-8

Returns

Return Type	Description
List<FileInformation>	The list containing all the attachments.

<clarizen:download-file-information>

Download file information

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
entity	#[payload]	Optional. Document entity	BaseClarizenEntity	/
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.
connectionUser		Optional. The user login user	String	/	UTF-8
connectionPassword		Optional. The user login pass	String	/	UTF-8
applicationId		Optional. The id of a specific partner application that can be used for licensing purposed	String	/	UTF-8
partnerId		Optional. The id of a Clarizen partner	String	/	UTF-8

Returns

Return Type	Description
FileInformation	entity file information

<clarizen:entity-query>

Create an entity query

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
queryTypeName		The entity type	String	/	UTF-8
condition		Optional. The query condition. For further information about the condition object check `Condition`	Condition	/
pageSize	100	Optional. The number of results to be retrieved per page	Integer	/
maxNumberOfPages	100	Optional. The maximum number of pages to be retrieved	Integer	/
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.
connectionUser		Optional. The user login user	String	/	UTF-8
connectionPassword		Optional. The user login pass	String	/	UTF-8
applicationId		Optional. The id of a specific partner application that can be used for licensing purposed	String	/	UTF-8
partnerId		Optional. The id of a Clarizen partner	String	/	UTF-8

Child Elements

Name	Default Value	Description	Java Type
<clarizen:fields-to-retrieve>		The fields to be retrieved. The fields names are the keys of the map	List<String>

Returns

Return Type	Description
List<BaseClarizenEntity>	ArrayOfEntity List of work item results

<clarizen:get-calendar-information>

Gets calendar information for the specified user

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
userId	#[payload]	Optional. The userId entityId	EntityId	/
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.
connectionUser		Optional. The user login user	String	/	UTF-8
connectionPassword		Optional. The user login pass	String	/	UTF-8
applicationId		Optional. The id of a specific partner application that can be used for licensing purposed	String	/	UTF-8
partnerId		Optional. The id of a Clarizen partner	String	/	UTF-8

Returns

Return Type	Description
GetCalendarInfoResult	calendar information

<clarizen:get-my-work-items>

Returns the work items for the current user

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
workItemState		The work items state. For further information about the specific values check `WorkItemState`	WorkItemState	/
workItemType		The work item type. For further information about the specific values check `WorkItemType`	WorkItemType	/
workItemFilter		The work items filter. For further information about the specific values check `WorkItemFilter`	WorkItemFilter	/
pageSize	100	Optional. The number of results to be retrieved per page	Integer	/
maxNumberOfPages	100	Optional. The maximum number of pages to be retrieved	Integer	/
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.
connectionUser		Optional. The user login user	String	/	UTF-8
connectionPassword		Optional. The user login pass	String	/	UTF-8
applicationId		Optional. The id of a specific partner application that can be used for licensing purposed	String	/	UTF-8
partnerId		Optional. The id of a Clarizen partner	String	/	UTF-8

Child Elements

Name	Default Value	Description	Java Type
<clarizen:fields-to-retrieve>	#[payload]	Optional. The fields to be retrieved. The fields names are the keys of the map	List<String>

Returns

Return Type	Description
List<BaseClarizenEntity>	ArrayOfEntity List of work items

<clarizen:get-system-settings>

Gets system settings values

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.
connectionUser	Optional. The user login user	String	/	UTF-8
connectionPassword	Optional. The user login pass	String	/	UTF-8
applicationId	Optional. The id of a specific partner application that can be used for licensing purposed	String	/	UTF-8
partnerId	Optional. The id of a Clarizen partner	String	/	UTF-8

Child Elements

Name	Default Value	Description	Java Type
<clarizen:settings>	#[payload]	Optional. List	List<String>

Returns

Return Type	Description
List<Object>	system settings

<clarizen:get-work-item-by-id>

Retrieves a workitem by id.

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
workItemType	The work item type. For further information about the specific values check `WorkItemType`	WorkItemType	/
workItemId	The work item id	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.
connectionUser	Optional. The user login user	String	/	UTF-8
connectionPassword	Optional. The user login pass	String	/	UTF-8
applicationId	Optional. The id of a specific partner application that can be used for licensing purposed	String	/	UTF-8
partnerId	Optional. The id of a Clarizen partner	String	/	UTF-8

Child Elements

Name	Default Value	Description	Java Type
<clarizen:fields-to-retrieve>	#[payload]	Optional. The list of the work item fields to be retrieved. The fields names are the keys of the map	List<String>

Returns

Return Type	Description
BaseClarizenEntity	Work item with fields indicated through fieldToRetrieve

<clarizen:issue-query>

Create an issues query

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
issueType		The issue type to be retrieved	AllIssueType	/
condition		Optional. The query condition. For further information about the condition object check `Condition`	Condition	/
pageSize	100	Optional. The number of results to be retrieved per page.	Integer	/
maxNumberOfPages	100	Optional. The maximum number of pages to be retrieved	Integer	/
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.
connectionUser		Optional. The user login user	String	/	UTF-8
connectionPassword		Optional. The user login pass	String	/	UTF-8
applicationId		Optional. The id of a specific partner application that can be used for licensing purposed	String	/	UTF-8
partnerId		Optional. The id of a Clarizen partner	String	/	UTF-8

Child Elements

Name	Default Value	Description	Java Type
<clarizen:fields-to-retrieve>		The fields to be retrieved. The fields names are the keys of the map	List<String>

Returns

Return Type	Description
List<BaseClarizenEntity>	ArrayOfEntity List of issues results

<clarizen:lifecycle-change>

Performs lifecycle changes on an entity or a group of entities

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
operation	The operation to be performed	String	/	UTF-8
recursive	If the operation will be recursived	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.
connectionUser	Optional. The user login user	String	/	UTF-8
connectionPassword	Optional. The user login pass	String	/	UTF-8
applicationId	Optional. The id of a specific partner application that can be used for licensing purposed	String	/	UTF-8
partnerId	Optional. The id of a Clarizen partner	String	/	UTF-8

Child Elements

Name	Default Value	Description	Java Type
<clarizen:entity-id-list>	#[payload]	Optional. The list of entities to be updated	List<EntityId>

Returns

Return Type	Description
Boolean	true if the change was successful

<clarizen:list-entities>

Returns the list of entities

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.
connectionUser	Optional. The user login user	String	/	UTF-8
connectionPassword	Optional. The user login pass	String	/	UTF-8
applicationId	Optional. The id of a specific partner application that can be used for licensing purposed	String	/	UTF-8
partnerId	Optional. The id of a Clarizen partner	String	/	UTF-8

Returns

Return Type	Description
List<String>	List of entities

<clarizen:retrieve-work-item-human-resources>

Given a certain Entity Id representing a work item, retrieves all associated human resources.

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
entityId	The entity Id associated with a work item	EntityId	/
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.
connectionUser	Optional. The user login user	String	/	UTF-8
connectionPassword	Optional. The user login pass	String	/	UTF-8
applicationId	Optional. The id of a specific partner application that can be used for licensing purposed	String	/	UTF-8
partnerId	Optional. The id of a Clarizen partner	String	/	UTF-8

Child Elements

Name	Default Value	Description	Java Type
<clarizen:fields-to-retrieve>		List of strings representing the fields to retrieve	List<String>

Returns

Return Type	Description
List<GenericEntity>	The list containing all the human resources.

<clarizen:send-email>

Sends an email to the specified recipients

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
accessType	PUBLIC or PRIVATE	AccessType	/
relatedEntity	Optional. Entity related to the email	BaseClarizenEntity	/
body	Optional. Message body	String	/	UTF-8
subject	Optional. Message subject	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.
connectionUser	Optional. The user login user	String	/	UTF-8
connectionPassword	Optional. The user login pass	String	/	UTF-8
applicationId	Optional. The id of a specific partner application that can be used for licensing purposed	String	/	UTF-8
partnerId	Optional. The id of a Clarizen partner	String	/	UTF-8

Child Elements

Name	Default Value	Description	Java Type
<clarizen:recipients>		Optional. List of recipients	List<Recipient>

Returns

Return Type	Description
Boolean	true if the action was successful

<clarizen:update-entity>

Updates a new Clarizen entity

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
entity	#[payload]	Optional. Entity to be updated	BaseClarizenEntity	/
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.
connectionUser		Optional. The user login user	String	/	UTF-8
connectionPassword		Optional. The user login pass	String	/	UTF-8
applicationId		Optional. The id of a specific partner application that can be used for licensing purposed	String	/	UTF-8
partnerId		Optional. The id of a Clarizen partner	String	/	UTF-8

Returns

Return Type	Description
BaseClarizenEntity	Created entity

<clarizen:update-generic-entity>

Updates a Clarizen generic entity

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
entity	#[payload]	Optional. Entity to be updated	GenericEntity	/
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.
connectionUser		Optional. The user login user	String	/	UTF-8
connectionPassword		Optional. The user login pass	String	/	UTF-8
applicationId		Optional. The id of a specific partner application that can be used for licensing purposed	String	/	UTF-8
partnerId		Optional. The id of a Clarizen partner	String	/	UTF-8

Returns

Return Type	Description
GenericEntity	Created entity

<clarizen:work-items-query>

Search for work items

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
workItemState		The work items state. For further information about the specific values check `WorkItemState`	WorkItemState	/
workItemType		The work item type. For further information about the specific values check `WorkItemType`	WorkItemType	/
workItemFilter		The work items filter. For further information about the specific values check `WorkItemFilter`	WorkItemFilter	/
pageSize	100	Optional. The number of results to be retrieved per page	Integer	/
maxNumberOfPages	100	Optional. The maximum number of pages to be retrieved	Integer	/
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.
connectionUser		Optional. The user login user	String	/	UTF-8
connectionPassword		Optional. The user login pass	String	/	UTF-8
applicationId		Optional. The id of a specific partner application that can be used for licensing purposed	String	/	UTF-8
partnerId		Optional. The id of a Clarizen partner	String	/	UTF-8

Child Elements

Name	Default Value	Description	Java Type
<clarizen:fields-to-retrieve>	#[payload]	Optional. The fields to be retrieved. The fields names are the keys of the map	List<String>

Returns

Return Type	Description
List<BaseClarizenEntity>	ArrayOfEntity List of work item results