Contact Us 1-800-596-4880
  1. Homepage
  2. Teamwork Connector (0.1)

  3. Teamwork Connector Reference

All Connectors

Teamwork Connector 0.1.0 Reference

Configurations

Config

Default configuration.

Parameters

Name Type Description Default Value Required

Name

String

The name for this configuration. Connectors reference the configuration with this name.

x

Connection

Basic Auth

The connection types to provide to this configuration.

x

Name

String

The identifier of this element used to reference it in other components.

x

Expiration Policy

Expiration Policy

Configures the minimum amount of time that a dynamic configuration instance can remain idle before Mule considers it eligible for expiration. This does not mean that the platform expires the instance at the exact moment that it becomes eligible. Mule purges the instances as appropriate.

Connection Types

Basic Auth
Parameters
Name Type Description Default Value Required

baseUri

String

The base URI for the Teamwork API.

x

password

String

The password to authenticate the requests.

x

username

String

The username to authenticate the requests.

x

TLS Configuration

TLS

The TLS configuration for secure connections.

Reconnection

Reconnection

When the application is deployed, a connectivity test is performed on all connectors. If set to true, deployment fails if the test doesn’t pass after exhausting the associated reconnection strategy.

Supported Operations

Operations

createTimer

<teamwork:create-timer>

Creates a timer entry in Teamwork.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

body

Any

The request body content.

#[payload]

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component.

x

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Output

Type

Any

Attributes Type

Any

For Configurations

Throws

  • TEAMWORK:BAD_REQUEST

  • TEAMWORK:CLIENT_ERROR

  • TEAMWORK:CONNECTIVITY

  • TEAMWORK:FORBIDDEN

  • TEAMWORK:INTERNAL_SERVER_ERROR

  • TEAMWORK:SECURITY

  • TEAMWORK:SERVER_ERROR

  • TEAMWORK:TIMEOUT

  • TEAMWORK:UNAUTHORIZED

deleteTimer

<teamwork:delete-timer>

Deletes a timer entry in Teamwork.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

timerId

Number

ID of the timer to delete.

x

body

Any

The request body content.

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component.

x

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Output

Type

Null

Attributes Type

Any

For Configurations

Throws

  • TEAMWORK:BAD_REQUEST

  • TEAMWORK:CLIENT_ERROR

  • TEAMWORK:CONNECTIVITY

  • TEAMWORK:FORBIDDEN

  • TEAMWORK:INTERNAL_SERVER_ERROR

  • TEAMWORK:NOT_FOUND

  • TEAMWORK:SECURITY

  • TEAMWORK:SERVER_ERROR

  • TEAMWORK:TIMEOUT

  • TEAMWORK:UNAUTHORIZED

getAllProjectUpdates

<teamwork:get-all-project-updates>

Retrieves all project updates from Teamwork.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

updatedAfter

String

Filter project updates updated after this date.

projectStatus

String

Filter by project status.

orderMode

Enumeration, one of:

  • asc

  • desc

Sort order mode.

orderBy

Enumeration, one of:

  • date

  • color

  • health

  • project

  • user

Field to sort by.

createdAfter

String

Filter project updates created after this date.

projectId

Number

Filter by project ID.

pageSize

Number

Number of results per page.

page

Number

Page number to retrieve.

skipCounts

Boolean

Skip count calculations.

false

showDeleted

Boolean

Include deleted items in results.

false

reactions

Boolean

Include reactions in results.

false

onlyStarredProjects

Boolean

Return only starred projects.

false

matchAllProjectTags

Boolean

Match all project tags.

false

includeArchivedProjects

Boolean

Include archived projects in results.

false

emoji

Boolean

Include emoji in results.

false

activeOnly

Boolean

Return only active projects.

false

projectTagIds

Array of Number

Filter by project tag IDs.

projectStatuses

Array of String

Filter by project statuses.

projectOwnerIds

Array of Number

Filter by project owner IDs.

projectHealths

Array of Number

Filter by project health levels.

projectCompanyIds

Array of Number

Filter by project company IDs.

projectCategoryIds

Array of Number

Filter by project category IDs.

include

Array of String

Fields to include in the response.

fields[users]

Array of String

User fields to include in the response.

fields[projects]

Array of String

Project fields to include in the response.

fields[projectUpdates]

Array of String

Project update fields to include in the response.

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component.

x

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Output

Type

Any

Attributes Type

Any

For Configurations

Throws

  • TEAMWORK:CLIENT_ERROR

  • TEAMWORK:CONNECTIVITY

  • TEAMWORK:FORBIDDEN

  • TEAMWORK:INTERNAL_SERVER_ERROR

  • TEAMWORK:NOT_FOUND

  • TEAMWORK:SECURITY

  • TEAMWORK:SERVER_ERROR

  • TEAMWORK:TIMEOUT

  • TEAMWORK:UNAUTHORIZED

getAllTasklists

<teamwork:get-all-tasklists>

Retrieves all task lists from Teamwork.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

page

Number

Page number to retrieve.

pageSize

Number

Number of results per page.

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component.

x

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Output

Type

Any

Attributes Type

Any

For Configurations

Throws

  • TEAMWORK:CLIENT_ERROR

  • TEAMWORK:CONNECTIVITY

  • TEAMWORK:FORBIDDEN

  • TEAMWORK:INTERNAL_SERVER_ERROR

  • TEAMWORK:SECURITY

  • TEAMWORK:SERVER_ERROR

  • TEAMWORK:TIMEOUT

  • TEAMWORK:UNAUTHORIZED

getAllTimeEntries

<teamwork:get-all-time-entries>

Retrieves all time entries from Teamwork.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

page

Number

Page number to retrieve.

pageSize

Number

Number of results per page.

updatedAfter

String

Filter time entries updated after this date.

startDate

String

Filter time entries from this start date.

endDate

String

Filter time entries until this end date.

deletedAfter

String

Filter time entries deleted after this date.

reportFormat

String

Format for the report output.

projectStatus

Enumeration, one of:

  • active

  • current

  • late

  • upcoming

  • completed

  • deleted

Filter by project status.

orderMode

Enumeration, one of:

  • asc

  • desc

Sort order mode.

orderBy

Enumeration, one of:

  • company

  • date

  • dateupdated

  • project

  • task

  • tasklist

  • user

  • description

  • billed

  • billable

  • timespent

Field to sort by.

invoicedType

Enumeration, one of:

  • all

  • invoiced

  • noninvoiced

Filter by invoiced status.

billableType

Enumeration, one of:

  • all

  • billable

  • non-billable

Filter by billable status.

updatedBy

Number

Filter by user ID who updated the entry.

ticketId

Number

Filter by ticket ID.

tasklistId

Number

Filter by task list ID.

invoiceId

Number

Filter by invoice ID.

budgetId

Number

Filter by budget ID.

allocationId

Number

Filter by allocation ID.

useFallbackMethod

Boolean

Use fallback method for retrieval.

false

unattachedTimelogs

Boolean

Include unattached time logs.

false

skipCounts

Boolean

Skip count calculations.

false

showDeleted

Boolean

Include deleted items in results.

false

returnCostInfo

Boolean

Include cost information in response.

false

returnBillableInfo

Boolean

Include billable information in response.

false

onlyStarredProjects

Boolean

Return only starred projects.

false

matchAllTaskTags

Boolean

Match all task tags.

false

matchAllTags

Boolean

Match all tags.

false

matchAllProjectTags

Boolean

Match all project tags.

false

isReportDownload

Boolean

Return results as a report download.

false

includeTotals

Boolean

Include totals in response.

false

includePermissions

Boolean

Include permissions in response.

false

includeDescendants

Boolean

Include descendant items.

false

includeArchivedProjects

Boolean

Include archived projects in results.

false

deletedOnly

Boolean

Return only deleted items.

false

taskTagIds

Array of Number

Filter by task tag IDs.

taskStatuses

Array of String

Filter by task statuses.

taskIds

Array of Number

Filter by task IDs.

tagIds

Array of Number

Filter by tag IDs.

selectedColumns

Array of String

Columns to include in the response.

projectTagIds

Array of Number

Filter by project tag IDs.

projectStatuses

Array of String

Filter by project statuses.

projectOwnerIds

Array of Number

Filter by project owner IDs.

projectIds

Array of Number

Filter by project IDs.

projectHealths

Array of Number

Filter by project health levels.

projectCompanyIds

Array of Number

Filter by project company IDs.

projectCategoryIds

Array of Number

Filter by project category IDs.

include

Array of String

Fields to include in the response.

ids

Array of Number

Filter by specific time entry IDs.

assignedToUserIds

Array of Number

Filter by assigned user IDs.

assignedToTeamIds

Array of Number

Filter by assigned team IDs.

assignedToCompanyIds

Array of Number

Filter by assigned company IDs.

assignedTeamIds

Array of Number

Filter by team IDs.

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component.

x

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Output

Type

Any

Attributes Type

Any

For Configurations

Throws

  • TEAMWORK:CLIENT_ERROR

  • TEAMWORK:CONNECTIVITY

  • TEAMWORK:FORBIDDEN

  • TEAMWORK:INTERNAL_SERVER_ERROR

  • TEAMWORK:SECURITY

  • TEAMWORK:SERVER_ERROR

  • TEAMWORK:TIMEOUT

  • TEAMWORK:UNAUTHORIZED

getAllocationTimeEntries

<teamwork:get-allocation-time-entries>

Retrieves time entries for a specific allocation from Teamwork.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

allocationId

Number

ID of the allocation to retrieve time entries for.

x

page

Number

Page number to retrieve.

pageSize

Number

Number of results per page.

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component.

x

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Output

Type

Any

Attributes Type

Any

For Configurations

Throws

  • TEAMWORK:CLIENT_ERROR

  • TEAMWORK:CONNECTIVITY

  • TEAMWORK:FORBIDDEN

  • TEAMWORK:INTERNAL_SERVER_ERROR

  • TEAMWORK:NOT_FOUND

  • TEAMWORK:SECURITY

  • TEAMWORK:SERVER_ERROR

  • TEAMWORK:TIMEOUT

  • TEAMWORK:UNAUTHORIZED

getProjectById

<teamwork:get-project-by-id>

Retrieves a project by ID from Teamwork.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

projectId

Number

ID of the project to retrieve.

x

updatedAfter

String

Filter projects updated after this date.

timeMode

Enumeration, one of:

  • timelogs

  • estimated

Time calculation mode.

searchTerm

String

Search term to filter projects.

reportType

Enumeration, one of:

  • project

  • health

Type of report to generate.

reportTimezone

String

Timezone for the report.

reportFormat

Enumeration, one of:

  • csv

  • html

  • pdf

  • xls

Format for the report output.

projectType

String

Filter by project type.

orderMode

Enumeration, one of:

  • asc

  • desc

Sort order mode.

orderBy

Enumeration, one of:

  • companyname

  • datecreated

  • duedate

  • lastactivity

  • name

  • namecaseinsensitive

  • ownercompany

  • starred

  • categoryname

Field to sort by.

notCompletedBefore

String

Filter projects not completed before this date.

minLastActivityDate

String

Minimum last activity date filter.

maxLastActivityDate

String

Maximum last activity date filter.

userId

Number

Filter by user ID.

page

Number

Page number to retrieve.

pageSize

Number

Number of results per page.

orderByCustomFieldId

Number

Custom field ID to sort by.

minBudgetCapacityUsedPercent

Number

Minimum budget capacity used percentage.

maxBudgetCapacityUsedPercent

Number

Maximum budget capacity used percentage.

useFormulaFields

Boolean

Use formula fields in calculations.

false

skipCounts

Boolean

Skip count calculations.

false

searchCompanies

Boolean

Include companies in search.

false

searchByLetter

Boolean

Search by first letter.

false

onlyStarredProjects

Boolean

Return only starred projects.

false

onlyProjectsWithExplicitMembership

Boolean

Return only projects with explicit membership.

false

onlyProjectsThatCanLogTime

Boolean

Return only projects that can log time.

false

onlyProjectsThatCanAddTasks

Boolean

Return only projects that can add tasks.

false

onlyArchivedProjects

Boolean

Return only archived projects.

false

matchAllProjectTags

Boolean

Match all project tags.

false

matchAllExcludedTags

Boolean

Match all excluded tags.

false

isReportDownload

Boolean

Return results as a report download.

false

includeTentativeProjects

Boolean

Include tentative projects in results.

false

includeSubCategories

Boolean

Include subcategories in results.

false

includeStats

Boolean

Include statistics in response.

false

includeProjectUserInfo

Boolean

Include project user information.

false

includeProjectProfitability

Boolean

Include project profitability information.

false

includeProjectDates

Boolean

Include project date information.

false

includeCustomFields

Boolean

Include custom fields in response.

false

includeCounts

Boolean

Include counts in response.

false

includeCompletedStatus

Boolean

Include completed status information.

false

includeArchivedProjects

Boolean

Include archived projects in results.

false

hideObservedProjects

Boolean

Hide observed projects.

false

alwaysIncludeFiltering

Boolean

Always include filtering.

false

usersWithExplicitMembershipIds

Array of Number

Filter by user IDs with explicit membership.

teamIds

Array of Number

Filter by team IDs.

selectedColumns

Array of String

Columns to include in the response.

projectTagIds

Array of Number

Filter by project tag IDs.

projectStatuses

Array of String

Filter by project statuses.

projectOwnerIds

Array of Number

Filter by project owner IDs.

projectIds

Array of Number

Filter by project IDs.

projectHealths

Array of Number

Filter by project health levels.

projectCompanyIds

Array of Number

Filter by project company IDs.

projectCategoryIds

Array of Number

Filter by project category IDs.

includeCustomFieldIds

Array of Number

Custom field IDs to include.

include

Array of String

Fields to include in the response.

featuresEnabled

Array of String

Enabled features to filter by.

excludeTagIds

Array of Number

Tag IDs to exclude.

excludeProjectIds

Array of Number

Project IDs to exclude.

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component.

x

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Output

Type

Any

Attributes Type

Any

For Configurations

Throws

  • TEAMWORK:CLIENT_ERROR

  • TEAMWORK:CONNECTIVITY

  • TEAMWORK:FORBIDDEN

  • TEAMWORK:INTERNAL_SERVER_ERROR

  • TEAMWORK:NOT_FOUND

  • TEAMWORK:SECURITY

  • TEAMWORK:SERVER_ERROR

  • TEAMWORK:TIMEOUT

  • TEAMWORK:UNAUTHORIZED

getProjectTasklists

<teamwork:get-project-tasklists>

Retrieves task lists for a project from Teamwork.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

projectId

Number

ID of the project to retrieve task lists for.

x

updatedAfter

String

Filter task lists updated after this date.

searchTerm

String

Search term to filter task lists.

projectType

String

Filter by project type.

orderMode

Enumeration, one of:

  • asc

  • desc

Sort order mode.

orderBy

Enumeration, one of:

  • displayorder

  • name

  • status

  • createdat

  • updatedat

  • project

Field to sort by.

projectBudgetId

Number

Filter by project budget ID.

pageSize

Number

Number of results per page.

page

Number

Page number to retrieve.

useFormulaFields

Boolean

Use formula fields in calculations.

false

sortDefaultListFirst

Boolean

Sort default list first.

false

sortActiveListsFirst

Boolean

Sort active lists first.

false

skipCounts

Boolean

Skip count calculations.

false

showPrivate

Boolean

Include private task lists.

false

showDeleted

Boolean

Include deleted task lists.

false

showCompleted

Boolean

Include completed task lists.

false

isReportDownload

Boolean

Return results as a report download.

false

includeArchivedProjects

Boolean

Include archived projects in results.

false

getEmptyLists

Boolean

Include empty task lists.

false

completedOnly

Boolean

Return only completed task lists.

false

projectIds

Array of Number

Filter by project IDs.

projectCompanyIds

Array of Number

Filter by project company IDs.

include

Array of String

Fields to include in the response.

ids

Array of Number

Filter by specific task list IDs.

fields[users]

Array of String

User fields to include in the response.

fields[teams]

Array of String

Team fields to include in the response.

fields[tasks]

Array of String

Task fields to include in the response.

fields[tasklists]

Array of String

Task list fields to include in the response.

fields[tags]

Array of String

Tag fields to include in the response.

fields[projects]

Array of String

Project fields to include in the response.

fields[projectIntegrations]

Array of String

Project integration fields to include in the response.

fields[milestones]

Array of String

Milestone fields to include in the response.

fields[lockdowns]

Array of String

Lockdown fields to include in the response.

fields[companies]

Array of String

Company fields to include in the response.

fields[ProjectPermissions]

Array of String

Project permission fields to include in the response.

excludeIds

Array of Number

Task list IDs to exclude.

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component.

x

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Output

Type

Any

Attributes Type

Any

For Configurations

Throws

  • TEAMWORK:CLIENT_ERROR

  • TEAMWORK:CONNECTIVITY

  • TEAMWORK:FORBIDDEN

  • TEAMWORK:INTERNAL_SERVER_ERROR

  • TEAMWORK:NOT_FOUND

  • TEAMWORK:SECURITY

  • TEAMWORK:SERVER_ERROR

  • TEAMWORK:TIMEOUT

  • TEAMWORK:UNAUTHORIZED

getProjects

<teamwork:get-projects>

Retrieves all projects from Teamwork.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

page

Number

Page number to retrieve.

pageSize

Number

Number of results per page.

updatedAfter

String

Filter projects updated after this date.

timeMode

Enumeration, one of:

  • timelogs

  • estimated

Time calculation mode.

searchTerm

String

Search term to filter projects.

reportType

Enumeration, one of:

  • project

  • health

Type of report to generate.

reportTimezone

String

Timezone for the report.

reportFormat

Enumeration, one of:

  • csv

  • html

  • pdf

  • xls

Format for the report output.

projectType

String

Filter by project type.

orderMode

Enumeration, one of:

  • asc

  • desc

Sort order mode.

orderBy

Enumeration, one of:

  • companyname

  • datecreated

  • duedate

  • lastactivity

  • name

  • namecaseinsensitive

  • ownercompany

  • starred

  • categoryname

Field to sort by.

notCompletedBefore

String

Filter projects not completed before this date.

minLastActivityDate

String

Minimum last activity date filter.

maxLastActivityDate

String

Maximum last activity date filter.

userId

Number

Filter by user ID.

orderByCustomFieldId

Number

Custom field ID to sort by.

minBudgetCapacityUsedPercent

Number

Minimum budget capacity used percentage.

maxBudgetCapacityUsedPercent

Number

Maximum budget capacity used percentage.

useFormulaFields

Boolean

Use formula fields in calculations.

false

skipCounts

Boolean

Skip count calculations.

false

searchCompanies

Boolean

Include companies in search.

false

searchByLetter

Boolean

Search by first letter.

false

onlyStarredProjects

Boolean

Return only starred projects.

false

onlyProjectsWithExplicitMembership

Boolean

Return only projects with explicit membership.

false

onlyProjectsThatCanLogTime

Boolean

Return only projects that can log time.

false

onlyProjectsThatCanAddTasks

Boolean

Return only projects that can add tasks.

false

onlyArchivedProjects

Boolean

Return only archived projects.

false

matchAllProjectTags

Boolean

Match all project tags.

false

matchAllExcludedTags

Boolean

Match all excluded tags.

false

isReportDownload

Boolean

Return results as a report download.

false

includeTentativeProjects

Boolean

Include tentative projects in results.

false

includeSubCategories

Boolean

Include subcategories in results.

false

includeStats

Boolean

Include statistics in response.

false

includeProjectUserInfo

Boolean

Include project user information.

false

includeProjectProfitability

Boolean

Include project profitability information.

false

includeProjectDates

Boolean

Include project date information.

false

includeCustomFields

Boolean

Include custom fields in response.

false

includeCounts

Boolean

Include counts in response.

false

includeCompletedStatus

Boolean

Include completed status information.

false

includeArchivedProjects

Boolean

Include archived projects in results.

false

hideObservedProjects

Boolean

Hide observed projects.

false

alwaysIncludeFiltering

Boolean

Always include filtering.

false

usersWithExplicitMembershipIds

Array of Number

Filter by user IDs with explicit membership.

teamIds

Array of Number

Filter by team IDs.

selectedColumns

Array of String

Columns to include in the response.

projectTagIds

Array of Number

Filter by project tag IDs.

projectStatuses

Array of String

Filter by project statuses.

projectOwnerIds

Array of Number

Filter by project owner IDs.

projectIds

Array of Number

Filter by project IDs.

projectHealths

Array of Number

Filter by project health levels.

projectCompanyIds

Array of Number

Filter by project company IDs.

projectCategoryIds

Array of Number

Filter by project category IDs.

includeCustomFieldIds

Array of Number

Custom field IDs to include.

include

Array of String

Fields to include in the response.

featuresEnabled

Array of String

Enabled features to filter by.

excludeTagIds

Array of Number

Tag IDs to exclude.

excludeProjectIds

Array of Number

Project IDs to exclude.

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component.

x

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Output

Type

Any

Attributes Type

Any

For Configurations

Throws

  • TEAMWORK:CLIENT_ERROR

  • TEAMWORK:CONNECTIVITY

  • TEAMWORK:FORBIDDEN

  • TEAMWORK:INTERNAL_SERVER_ERROR

  • TEAMWORK:SECURITY

  • TEAMWORK:SERVER_ERROR

  • TEAMWORK:TIMEOUT

  • TEAMWORK:UNAUTHORIZED

getTasklistById

<teamwork:get-tasklist-by-id>

Retrieves a task list by ID from Teamwork.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

tasklistId

Number

ID of the task list to retrieve.

x

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component.

x

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Output

Type

Any

Attributes Type

Any

For Configurations

Throws

  • TEAMWORK:CLIENT_ERROR

  • TEAMWORK:CONNECTIVITY

  • TEAMWORK:FORBIDDEN

  • TEAMWORK:INTERNAL_SERVER_ERROR

  • TEAMWORK:NOT_FOUND

  • TEAMWORK:SECURITY

  • TEAMWORK:SERVER_ERROR

  • TEAMWORK:TIMEOUT

  • TEAMWORK:UNAUTHORIZED

Types

TLS

Configures TLS to provide secure communications for the Mule app.

Field Type Description Default Value Required

Enabled Protocols

String

A comma-separated list of protocols enabled for this context.

Enabled Cipher Suites

String

A comma-separated list of cipher suites enabled for this context.

Trust Store

Truststore

Configures the TLS truststore.

Key Store

Keystore

Configures the TLS keystore.

Revocation Check

Configures a revocation checking mechanism.

Truststore

Configures the truststore for TLS.

Field Type Description Default Value Required

Path

String

The location (which will be resolved relative to the current classpath and file system, if possible) of the trust store.

Password

String

The password used to protect the trust store.

Type

String

The type of store used.

Algorithm

String

The algorithm used by the trust store.

Insecure

Boolean

If true, no certificate validations will be performed, rendering connections vulnerable to attacks. Use at your own risk.

Keystore

Configures the keystore for the TLS protocol. The keystore you generate contains a private key and a public certificate.

Field Type Description Default Value Required

Path

String

The location (which will be resolved relative to the current classpath and file system, if possible) of the key store.

Type

String

The type of store used.

Alias

String

When the key store contains many private keys, this attribute indicates the alias of the key that should be used. If not defined, the first key in the file will be used by default.

Key Password

String

The password used to protect the private key.

Password

String

The password used to protect the key store.

Algorithm

String

The algorithm used by the key store.

Standard Revocation Check

Configures standard revocation checks for TLS certificates.

Field Type Description Default Value Required

Only End Entities

Boolean

Which elements to verify in the certificate chain:

  • true

Verify only the last element in the certificate chain.

  • false

Verify all elements in the certificate chain.

Prefer Crls

Boolean

How to check certificate validity:

  • true

Check the Certification Revocation List (CRL) for certificate validity.

  • false

Use the Online Certificate Status Protocol (OCSP) to check certificate validity.

No Fallback

Boolean

Whether to use the secondary method to check certificate validity:

  • true

Use the method that wasn’t specified in the Prefer Crls field (the secondary method) to check certificate validity.

  • false

Do not use the secondary method to check certificate validity.

Soft Fail

Boolean

What to do if the revocation server can’t be reached or is busy:

  • true

Avoid verification failure.

  • false

Allow the verification to fail.

Custom OCSP Responder

Configures a custom OCSP responder for certification revocation checks.

Field Type Description Default Value Required

Url

String

The URL of the OCSP responder.

Cert Alias

String

Alias of the signing certificate for the OCSP response. If specified, the alias must be in the truststore.

CRL File

Specifies the location of the certification revocation list (CRL) file.

Field Type Description Default Value Required

Path

String

The path to the CRL file.

Reconnection

Configures a reconnection strategy for an operation.

Field Type Description Default Value Required

Fails Deployment

Boolean

When the application is deployed, a connectivity test is performed on all connectors. If set to true, deployment fails if the test doesn’t pass after exhausting the associated reconnection strategy.

Reconnection Strategy

The reconnection strategy to use.

Reconnect

Configures a standard reconnection strategy, which specifies how often to reconnect and how many reconnection attempts the connector source or operation can make.

Field Type Description Default Value Required

Frequency

Number

How often in milliseconds to reconnect.

Blocking

Boolean

If false, the reconnection strategy runs in a separate, non-blocking thread.

Count

Number

How many reconnection attempts the Mule app can make.

Reconnect Forever

Configures a forever reconnection strategy by which the connector source or operation attempts to reconnect at a specified frequency for as long as the Mule app runs.

Field Type Description Default Value Required

Frequency

Number

How often in milliseconds to reconnect.

Blocking

Boolean

If false, the reconnection strategy runs in a separate, non-blocking thread.

Expiration Policy

Configures an expiration policy strategy.

Field Type Description Default Value Required

Max Idle Time

Number

A scalar time value for the maximum amount of time a dynamic configuration instance should be allowed to be idle before it’s considered eligible for expiration.

Time Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Max Idle Time field.

Error Mapping

Configures error mappings for the connector operations.

Field Type Description Default Value Required

Source

Enumeration, one of:

  • ANY

  • REDELIVERY_EXHAUSTED

  • TRANSFORMATION

  • EXPRESSION

  • SECURITY

  • CLIENT_SECURITY

  • SERVER_SECURITY

  • ROUTING

  • CONNECTIVITY

  • RETRY_EXHAUSTED

  • TIMEOUT

Source of the error.

Target

String

Target of the error.

x
Back to top
View on GitHub