Skip to content

Latest commit

 

History

History
1176 lines (929 loc) · 47.1 KB

technical_reference.adoc

File metadata and controls

1176 lines (929 loc) · 47.1 KB

Salsify Connector Mule4Connector Module Connector Reference

Configurations

Config

Parameters

Name Type Description Default Value Required

Name

String

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

x 

Connection

The connection types that can be provided to this configuration.

x 

Response Timeout

Number

The timeout for request to the remote service.

60

 

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit which qualifies the Response Timeout}

SECONDS

 

Streaming Type

String

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

AUTO

 

Name

String

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

x 

Expiration Policy

Configures the minimum amount of time that a dynamic configuration instance can remain idle before the runtime considers it eligible for expiration. This does not mean that the platform will expire the instance at the exact moment that it becomes eligible. The runtime will actually purge the instances when it sees it fit.

 

Connection Types

Bearer Auth Connection Provider

This is the last layer of the connection provider generation gap pattern. It is what finally gets exposed as the connection provider, including all customizations made in the refinement layer.

Parameters
Name Type Description Default Value Required

Default headers

Object

 

Default query parameters

Object

 

Connection Timeout

Number

The timeout for establishing connections to the remote service

30

 

Connection Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit which qualifies the Connection Timeout

SECONDS

 

Use Persistent Connections

Boolean

If false, each connection will be closed after the first request is completed.

true

 

Max Connections

Number

The maximum number of outbound connections that will be kept open at the same time

-1

 

Connection Idle Timeout

Number

A timeout for how long a connection can remain idle before it is closed

30

 

Connection Idle Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit which qualifies the connection Idle Timeout

SECONDS

 

Stream Response

Boolean

Whether or not received responses should be streamed

false

 

Response Buffer Size

Number

The space in bytes for the buffer where the HTTP response will be stored.

-1

 

Token

String

The token used to authenticate the requests.

x 

Proxy Config

Reusable configuration element for outbound connections through a proxy. A proxy element must define a host name and a port attributes, and optionally can define a username and a password.

 

Protocol

Enumeration, one of:

  • HTTP

  • HTTPS

Protocol to use for communication. Valid values are HTTP and HTTPS

HTTP

 

TLS Configuration

Tls

 

Reconnection

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

 

Operations

Bulk Update Records

<salsify-connector-mule-4:bulk-update-records>

[Update up to 100 records](https://developers.salsify.com/reference#bulk-update-records) by sending an array of record objects. Each record object must contain the Salsify record identifier, and already exist in Salsify. This operation makes an HTTP PUT request to the /orgs/{organizationId}/records endpoint

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Organization Id

String

Your organization id

x 

X Salsify Client Id

Enumeration, one of:

  • MULESOFT_V1_0_0

X Salsify Client Id

MULESOFT_V1_0_0

 

Body

Array of Any

the content to use

#[payload]

 

Config Ref

ConfigurationProvider

The name of the configuration to be used to execute this component

x 

Custom Query Parameters

Object

#[null]

 

Custom Headers

Object

#[null]

 

Response Timeout

Number

The timeout for request to the remote service.

 

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit which qualifies the Response Timeout}

 

Streaming Type

String

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

For Configurations

Throws

  • SALSIFY-CONNECTOR-MULE-4:BAD_REQUEST  

  • SALSIFY-CONNECTOR-MULE-4:CLIENT_ERROR  

  • SALSIFY-CONNECTOR-MULE-4:CONNECTIVITY  

  • SALSIFY-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR  

  • SALSIFY-CONNECTOR-MULE-4:NOT_ACCEPTABLE  

  • SALSIFY-CONNECTOR-MULE-4:NOT_FOUND  

  • SALSIFY-CONNECTOR-MULE-4:RETRY_EXHAUSTED  

  • SALSIFY-CONNECTOR-MULE-4:SERVER_ERROR  

  • SALSIFY-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE  

  • SALSIFY-CONNECTOR-MULE-4:TIMEOUT  

  • SALSIFY-CONNECTOR-MULE-4:TOO_MANY_REQUESTS  

  • SALSIFY-CONNECTOR-MULE-4:UNAUTHORIZED  

  • SALSIFY-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE  

Bulk Upsert Digital Assets

<salsify-connector-mule-4:bulk-upsert-digital-assets>

Bulk Upsert Digital Assets This operation makes an HTTP PUT request to the /orgs/{organizationId}/digital_assets/_upsert endpoint

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Organization Id

String

Your organization id

x 

X Salsify Client Id

Enumeration, one of:

  • MULESOFT_V1_0_0

X Salsify Client Id

MULESOFT_V1_0_0

 

Body

Array of Any

the content to use

#[payload]

 

Config Ref

ConfigurationProvider

The name of the configuration to be used to execute this component

x 

Streaming Strategy

Configure if repeatable streams should be used and their behaviour

 

Custom Query Parameters

Object

#[null]

 

Custom Headers

Object

#[null]

 

Response Timeout

Number

The timeout for request to the remote service.

 

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit which qualifies the Response Timeout}

 

Streaming Type

String

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

 

Target Variable

String

The name of a variable on which the operation’s output will be placed

 

Target Value

String

An expression that will be evaluated against the operation’s output and the outcome of that expression will be stored in the target variable

#[payload]

 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

Output

Type

Array of String

Attributes Type

For Configurations

Throws

  • SALSIFY-CONNECTOR-MULE-4:BAD_REQUEST  

  • SALSIFY-CONNECTOR-MULE-4:CLIENT_ERROR  

  • SALSIFY-CONNECTOR-MULE-4:CONNECTIVITY  

  • SALSIFY-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR  

  • SALSIFY-CONNECTOR-MULE-4:NOT_ACCEPTABLE  

  • SALSIFY-CONNECTOR-MULE-4:NOT_FOUND  

  • SALSIFY-CONNECTOR-MULE-4:RETRY_EXHAUSTED  

  • SALSIFY-CONNECTOR-MULE-4:SERVER_ERROR  

  • SALSIFY-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE  

  • SALSIFY-CONNECTOR-MULE-4:TIMEOUT  

  • SALSIFY-CONNECTOR-MULE-4:TOO_MANY_REQUESTS  

  • SALSIFY-CONNECTOR-MULE-4:UNAUTHORIZED  

  • SALSIFY-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE  

Bulk Upsert Records

<salsify-connector-mule-4:bulk-upsert-records>

[Upsert](https://developers.salsify.com/reference#bulk-upsert-records) (create new and update existing) up to 100 records by sending an array of product objects. Each object must contain the Salsify record identifier. This operation makes an HTTP PUT request to the /orgs/{organizationId}/records/_upsert endpoint

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Organization Id

String

Your organization id

x 

X Salsify Client Id

Enumeration, one of:

  • MULESOFT_V1_0_0

X Salsify Client Id

MULESOFT_V1_0_0

 

Body

  • Any

  • Any

the content to use

#[payload]

 

Config Ref

ConfigurationProvider

The name of the configuration to be used to execute this component

x 

Streaming Strategy

Configure if repeatable streams should be used and their behaviour

 

Custom Query Parameters

Object

#[null]

 

Custom Headers

Object

#[null]

 

Response Timeout

Number

The timeout for request to the remote service.

 

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit which qualifies the Response Timeout}

 

Streaming Type

String

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

 

Target Variable

String

The name of a variable on which the operation’s output will be placed

 

Target Value

String

An expression that will be evaluated against the operation’s output and the outcome of that expression will be stored in the target variable

#[payload]

 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

Output

Type

Any

Attributes Type

For Configurations

Throws

  • SALSIFY-CONNECTOR-MULE-4:BAD_REQUEST  

  • SALSIFY-CONNECTOR-MULE-4:CLIENT_ERROR  

  • SALSIFY-CONNECTOR-MULE-4:CONNECTIVITY  

  • SALSIFY-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR  

  • SALSIFY-CONNECTOR-MULE-4:NOT_ACCEPTABLE  

  • SALSIFY-CONNECTOR-MULE-4:NOT_FOUND  

  • SALSIFY-CONNECTOR-MULE-4:RETRY_EXHAUSTED  

  • SALSIFY-CONNECTOR-MULE-4:SERVER_ERROR  

  • SALSIFY-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE  

  • SALSIFY-CONNECTOR-MULE-4:TIMEOUT  

  • SALSIFY-CONNECTOR-MULE-4:TOO_MANY_REQUESTS  

  • SALSIFY-CONNECTOR-MULE-4:UNAUTHORIZED  

  • SALSIFY-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE  

Create Digital Asset

<salsify-connector-mule-4:create-digital-asset>

Create a single or several new digital assets This operation makes an HTTP POST request to the /orgs/{organizationId}/digital_assets endpoint

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Organization Id

String

Your organization id

x 

X Salsify Client Id

Enumeration, one of:

  • MULESOFT_V1_0_0

X Salsify Client Id

MULESOFT_V1_0_0

 

Body

Array of Any

the content to use

#[payload]

 

Config Ref

ConfigurationProvider

The name of the configuration to be used to execute this component

x 

Streaming Strategy

Configure if repeatable streams should be used and their behaviour

 

Custom Query Parameters

Object

#[null]

 

Custom Headers

Object

#[null]

 

Response Timeout

Number

The timeout for request to the remote service.

 

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit which qualifies the Response Timeout}

 

Streaming Type

String

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

 

Target Variable

String

The name of a variable on which the operation’s output will be placed

 

Target Value

String

An expression that will be evaluated against the operation’s output and the outcome of that expression will be stored in the target variable

#[payload]

 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

Output

Type

Any

Attributes Type

For Configurations

Throws

  • SALSIFY-CONNECTOR-MULE-4:BAD_REQUEST  

  • SALSIFY-CONNECTOR-MULE-4:CLIENT_ERROR  

  • SALSIFY-CONNECTOR-MULE-4:CONNECTIVITY  

  • SALSIFY-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR  

  • SALSIFY-CONNECTOR-MULE-4:NOT_ACCEPTABLE  

  • SALSIFY-CONNECTOR-MULE-4:NOT_FOUND  

  • SALSIFY-CONNECTOR-MULE-4:RETRY_EXHAUSTED  

  • SALSIFY-CONNECTOR-MULE-4:SERVER_ERROR  

  • SALSIFY-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE  

  • SALSIFY-CONNECTOR-MULE-4:TIMEOUT  

  • SALSIFY-CONNECTOR-MULE-4:TOO_MANY_REQUESTS  

  • SALSIFY-CONNECTOR-MULE-4:UNAUTHORIZED  

  • SALSIFY-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE  

Create Records

<salsify-connector-mule-4:create-records>

Supports creation of [one](https://developers.salsify.com/reference#create-record) or up to [100 records](https://developers.salsify.com/reference#bulk-create-records) per request. Customer’s Salsify record identifier is required. This operation makes an HTTP POST request to the /orgs/{organizationId}/records endpoint

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Organization Id

String

Your organization id

x 

X Salsify Client Id

Enumeration, one of:

  • MULESOFT_V1_0_0

X Salsify Client Id

MULESOFT_V1_0_0

 

Body

  • Any

  • Any

the content to use

#[payload]

 

Config Ref

ConfigurationProvider

The name of the configuration to be used to execute this component

x 

Streaming Strategy

Configure if repeatable streams should be used and their behaviour

 

Custom Query Parameters

Object

#[null]

 

Custom Headers

Object

#[null]

 

Response Timeout

Number

The timeout for request to the remote service.

 

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit which qualifies the Response Timeout}

 

Streaming Type

String

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

 

Target Variable

String

The name of a variable on which the operation’s output will be placed

 

Target Value

String

An expression that will be evaluated against the operation’s output and the outcome of that expression will be stored in the target variable

#[payload]

 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

Output

Type

  • Any

  • Any

Attributes Type

For Configurations

Throws

  • SALSIFY-CONNECTOR-MULE-4:BAD_REQUEST  

  • SALSIFY-CONNECTOR-MULE-4:CLIENT_ERROR  

  • SALSIFY-CONNECTOR-MULE-4:CONNECTIVITY  

  • SALSIFY-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR  

  • SALSIFY-CONNECTOR-MULE-4:NOT_ACCEPTABLE  

  • SALSIFY-CONNECTOR-MULE-4:NOT_FOUND  

  • SALSIFY-CONNECTOR-MULE-4:RETRY_EXHAUSTED  

  • SALSIFY-CONNECTOR-MULE-4:SERVER_ERROR  

  • SALSIFY-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE  

  • SALSIFY-CONNECTOR-MULE-4:TIMEOUT  

  • SALSIFY-CONNECTOR-MULE-4:TOO_MANY_REQUESTS  

  • SALSIFY-CONNECTOR-MULE-4:UNAUTHORIZED  

  • SALSIFY-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE  

Get All Import Runs

<salsify-connector-mule-4:get-all-import-runs>

Retrieve the status of all runs from a given import This operation makes an HTTP GET request to the /orgs/{organizationId}/imports/{importId}/runs endpoint

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Organization Id

String

Your organization id

x 

Import Id

String

The id of an import run.

x 

X Salsify Client Id

Enumeration, one of:

  • MULESOFT_V1_0_0

X Salsify Client Id

MULESOFT_V1_0_0

 

Config Ref

ConfigurationProvider

The name of the configuration to be used to execute this component

x 

Streaming Strategy

Configure if repeatable streams should be used and their behaviour

 

Custom Query Parameters

Object

#[null]

 

Custom Headers

Object

#[null]

 

Response Timeout

Number

The timeout for request to the remote service.

 

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit which qualifies the Response Timeout}

 

Streaming Type

String

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

 

Target Variable

String

The name of a variable on which the operation’s output will be placed

 

Target Value

String

An expression that will be evaluated against the operation’s output and the outcome of that expression will be stored in the target variable

#[payload]

 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

Output

Type

Array of Any

Attributes Type

For Configurations

Throws

  • SALSIFY-CONNECTOR-MULE-4:BAD_REQUEST  

  • SALSIFY-CONNECTOR-MULE-4:CLIENT_ERROR  

  • SALSIFY-CONNECTOR-MULE-4:CONNECTIVITY  

  • SALSIFY-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR  

  • SALSIFY-CONNECTOR-MULE-4:NOT_ACCEPTABLE  

  • SALSIFY-CONNECTOR-MULE-4:NOT_FOUND  

  • SALSIFY-CONNECTOR-MULE-4:RETRY_EXHAUSTED  

  • SALSIFY-CONNECTOR-MULE-4:SERVER_ERROR  

  • SALSIFY-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE  

  • SALSIFY-CONNECTOR-MULE-4:TIMEOUT  

  • SALSIFY-CONNECTOR-MULE-4:TOO_MANY_REQUESTS  

  • SALSIFY-CONNECTOR-MULE-4:UNAUTHORIZED  

  • SALSIFY-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE  

Get Import Run

<salsify-connector-mule-4:get-import-run>

Retrieve the status of the current or most recent run of an import. This operation makes an HTTP GET request to the /orgs/{organizationId}/imports/runs/{importRunId} endpoint

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Organization Id

String

Your organization id

x 

Import Run Id

String

The specific run id of a given import

x 

X Salsify Client Id

Enumeration, one of:

  • MULESOFT_V1_0_0

X Salsify Client Id

MULESOFT_V1_0_0

 

Config Ref

ConfigurationProvider

The name of the configuration to be used to execute this component

x 

Streaming Strategy

Configure if repeatable streams should be used and their behaviour

 

Custom Query Parameters

Object

#[null]

 

Custom Headers

Object

#[null]

 

Response Timeout

Number

The timeout for request to the remote service.

 

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit which qualifies the Response Timeout}

 

Streaming Type

String

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

 

Target Variable

String

The name of a variable on which the operation’s output will be placed

 

Target Value

String

An expression that will be evaluated against the operation’s output and the outcome of that expression will be stored in the target variable

#[payload]

 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

Output

Type

Any

Attributes Type

For Configurations

Throws

  • SALSIFY-CONNECTOR-MULE-4:BAD_REQUEST  

  • SALSIFY-CONNECTOR-MULE-4:CLIENT_ERROR  

  • SALSIFY-CONNECTOR-MULE-4:CONNECTIVITY  

  • SALSIFY-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR  

  • SALSIFY-CONNECTOR-MULE-4:NOT_ACCEPTABLE  

  • SALSIFY-CONNECTOR-MULE-4:NOT_FOUND  

  • SALSIFY-CONNECTOR-MULE-4:RETRY_EXHAUSTED  

  • SALSIFY-CONNECTOR-MULE-4:SERVER_ERROR  

  • SALSIFY-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE  

  • SALSIFY-CONNECTOR-MULE-4:TIMEOUT  

  • SALSIFY-CONNECTOR-MULE-4:TOO_MANY_REQUESTS  

  • SALSIFY-CONNECTOR-MULE-4:UNAUTHORIZED  

  • SALSIFY-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE  

Get Record

<salsify-connector-mule-4:get-record>

[Retrieve one record](https://developers.salsify.com/reference/read-record). The URL must contain the Salsify record identifier as a parameter, and the record must already exist in Salsify. This operation makes an HTTP GET request to the /orgs/{organizationId}/records/{recordId} endpoint

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Organization Id

String

Your organization id

x 

Record Id

String

The Salsify record identifier for this record.

x 

X Salsify Client Id

Enumeration, one of:

  • MULESOFT_V1_0_0

X Salsify Client Id

MULESOFT_V1_0_0

 

Config Ref

ConfigurationProvider

The name of the configuration to be used to execute this component

x 

Streaming Strategy

Configure if repeatable streams should be used and their behaviour

 

Custom Query Parameters

Object

#[null]

 

Custom Headers

Object

#[null]

 

Response Timeout

Number

The timeout for request to the remote service.

 

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit which qualifies the Response Timeout}

 

Streaming Type

String

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

 

Target Variable

String

The name of a variable on which the operation’s output will be placed

 

Target Value

String

An expression that will be evaluated against the operation’s output and the outcome of that expression will be stored in the target variable

#[payload]

 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

Output

Type

Any

Attributes Type

For Configurations

Throws

  • SALSIFY-CONNECTOR-MULE-4:BAD_REQUEST  

  • SALSIFY-CONNECTOR-MULE-4:CLIENT_ERROR  

  • SALSIFY-CONNECTOR-MULE-4:CONNECTIVITY  

  • SALSIFY-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR  

  • SALSIFY-CONNECTOR-MULE-4:NOT_ACCEPTABLE  

  • SALSIFY-CONNECTOR-MULE-4:NOT_FOUND  

  • SALSIFY-CONNECTOR-MULE-4:RETRY_EXHAUSTED  

  • SALSIFY-CONNECTOR-MULE-4:SERVER_ERROR  

  • SALSIFY-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE  

  • SALSIFY-CONNECTOR-MULE-4:TIMEOUT  

  • SALSIFY-CONNECTOR-MULE-4:TOO_MANY_REQUESTS  

  • SALSIFY-CONNECTOR-MULE-4:UNAUTHORIZED  

  • SALSIFY-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE  

Read Digital Asset Metadata

<salsify-connector-mule-4:read-digital-asset-metadata>

Read Digital Asset Metadata This operation makes an HTTP GET request to the /orgs/{organizationId}/digital_assets/{digitalAssetId} endpoint

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Organization Id

String

Your organization id

x 

Digital Asset Id

String

The Id of the Salsify Digital Asset.

x 

X Salsify Client Id

Enumeration, one of:

  • MULESOFT_V1_0_0

X Salsify Client Id

MULESOFT_V1_0_0

 

Config Ref

ConfigurationProvider

The name of the configuration to be used to execute this component

x 

Streaming Strategy

Configure if repeatable streams should be used and their behaviour

 

Custom Query Parameters

Object

#[null]

 

Custom Headers

Object

#[null]

 

Response Timeout

Number

The timeout for request to the remote service.

 

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit which qualifies the Response Timeout}

 

Streaming Type

String

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

 

Target Variable

String

The name of a variable on which the operation’s output will be placed

 

Target Value

String

An expression that will be evaluated against the operation’s output and the outcome of that expression will be stored in the target variable

#[payload]

 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

Output

Type

Any

Attributes Type

For Configurations

Throws

  • SALSIFY-CONNECTOR-MULE-4:BAD_REQUEST  

  • SALSIFY-CONNECTOR-MULE-4:CLIENT_ERROR  

  • SALSIFY-CONNECTOR-MULE-4:CONNECTIVITY  

  • SALSIFY-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR  

  • SALSIFY-CONNECTOR-MULE-4:NOT_ACCEPTABLE  

  • SALSIFY-CONNECTOR-MULE-4:NOT_FOUND  

  • SALSIFY-CONNECTOR-MULE-4:RETRY_EXHAUSTED  

  • SALSIFY-CONNECTOR-MULE-4:SERVER_ERROR  

  • SALSIFY-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE  

  • SALSIFY-CONNECTOR-MULE-4:TIMEOUT  

  • SALSIFY-CONNECTOR-MULE-4:TOO_MANY_REQUESTS  

  • SALSIFY-CONNECTOR-MULE-4:UNAUTHORIZED  

  • SALSIFY-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE  

Refresh Digital Asset

<salsify-connector-mule-4:refresh-digital-asset>

Refresh Digital Asset This operation makes an HTTP POST request to the /orgs/{organizationId}/digital_assets/refresh endpoint

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Organization Id

String

Your organization id

x 

X Salsify Client Id

Enumeration, one of:

  • MULESOFT_V1_0_0

X Salsify Client Id

MULESOFT_V1_0_0

 

Body

Array of String

the content to use

#[payload]

 

Config Ref

ConfigurationProvider

The name of the configuration to be used to execute this component

x 

Streaming Strategy

Configure if repeatable streams should be used and their behaviour

 

Custom Query Parameters

Object

#[null]

 

Custom Headers

Object

#[null]

 

Response Timeout

Number

The timeout for request to the remote service.

 

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit which qualifies the Response Timeout}

 

Streaming Type

String

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

 

Target Variable

String

The name of a variable on which the operation’s output will be placed

 

Target Value

String

An expression that will be evaluated against the operation’s output and the outcome of that expression will be stored in the target variable

#[payload]

 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

Output

Type

Any

Attributes Type

For Configurations

Throws

  • SALSIFY-CONNECTOR-MULE-4:BAD_REQUEST  

  • SALSIFY-CONNECTOR-MULE-4:CLIENT_ERROR  

  • SALSIFY-CONNECTOR-MULE-4:CONNECTIVITY  

  • SALSIFY-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR  

  • SALSIFY-CONNECTOR-MULE-4:NOT_ACCEPTABLE  

  • SALSIFY-CONNECTOR-MULE-4:NOT_FOUND  

  • SALSIFY-CONNECTOR-MULE-4:RETRY_EXHAUSTED  

  • SALSIFY-CONNECTOR-MULE-4:SERVER_ERROR  

  • SALSIFY-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE  

  • SALSIFY-CONNECTOR-MULE-4:TIMEOUT  

  • SALSIFY-CONNECTOR-MULE-4:TOO_MANY_REQUESTS  

  • SALSIFY-CONNECTOR-MULE-4:UNAUTHORIZED  

  • SALSIFY-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE  

Start Import Run

<salsify-connector-mule-4:start-import-run>

Start a preconfigured import This operation makes an HTTP POST request to the /orgs/{organizationId}/imports/{importId}/runs endpoint

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Organization Id

String

Your organization id

x 

Import Id

String

The id of an import run.

x 

X Salsify Client Id

Enumeration, one of:

  • MULESOFT_V1_0_0

X Salsify Client Id

MULESOFT_V1_0_0

 

Config Ref

ConfigurationProvider

The name of the configuration to be used to execute this component

x 

Streaming Strategy

Configure if repeatable streams should be used and their behaviour

 

Custom Query Parameters

Object

#[null]

 

Custom Headers

Object

#[null]

 

Response Timeout

Number

The timeout for request to the remote service.

 

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit which qualifies the Response Timeout}

 

Streaming Type

String

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

 

Target Variable

String

The name of a variable on which the operation’s output will be placed

 

Target Value

String

An expression that will be evaluated against the operation’s output and the outcome of that expression will be stored in the target variable

#[payload]

 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

Output

Type

Any

Attributes Type

For Configurations

Throws

  • SALSIFY-CONNECTOR-MULE-4:BAD_REQUEST  

  • SALSIFY-CONNECTOR-MULE-4:CLIENT_ERROR  

  • SALSIFY-CONNECTOR-MULE-4:CONNECTIVITY  

  • SALSIFY-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR  

  • SALSIFY-CONNECTOR-MULE-4:NOT_ACCEPTABLE  

  • SALSIFY-CONNECTOR-MULE-4:NOT_FOUND  

  • SALSIFY-CONNECTOR-MULE-4:RETRY_EXHAUSTED  

  • SALSIFY-CONNECTOR-MULE-4:SERVER_ERROR  

  • SALSIFY-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE  

  • SALSIFY-CONNECTOR-MULE-4:TIMEOUT  

  • SALSIFY-CONNECTOR-MULE-4:TOO_MANY_REQUESTS  

  • SALSIFY-CONNECTOR-MULE-4:UNAUTHORIZED  

  • SALSIFY-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE  

Update Digital Asset

<salsify-connector-mule-4:update-digital-asset>

Update Digital Asset This operation makes an HTTP PUT request to the /orgs/{organizationId}/digital_assets/{digitalAssetId} endpoint

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Organization Id

String

Your organization id

x 

Digital Asset Id

String

The Id of the Salsify Digital Asset.

x 

X Salsify Client Id

Enumeration, one of:

  • MULESOFT_V1_0_0

X Salsify Client Id

MULESOFT_V1_0_0

 

Body

Any

the content to use

#[payload]

 

Config Ref

ConfigurationProvider

The name of the configuration to be used to execute this component

x 

Custom Query Parameters

Object

#[null]

 

Custom Headers

Object

#[null]

 

Response Timeout

Number

The timeout for request to the remote service.

 

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit which qualifies the Response Timeout}

 

Streaming Type

String

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

For Configurations

Throws

  • SALSIFY-CONNECTOR-MULE-4:BAD_REQUEST  

  • SALSIFY-CONNECTOR-MULE-4:CLIENT_ERROR  

  • SALSIFY-CONNECTOR-MULE-4:CONNECTIVITY  

  • SALSIFY-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR  

  • SALSIFY-CONNECTOR-MULE-4:NOT_ACCEPTABLE  

  • SALSIFY-CONNECTOR-MULE-4:NOT_FOUND  

  • SALSIFY-CONNECTOR-MULE-4:RETRY_EXHAUSTED  

  • SALSIFY-CONNECTOR-MULE-4:SERVER_ERROR  

  • SALSIFY-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE  

  • SALSIFY-CONNECTOR-MULE-4:TIMEOUT  

  • SALSIFY-CONNECTOR-MULE-4:TOO_MANY_REQUESTS  

  • SALSIFY-CONNECTOR-MULE-4:UNAUTHORIZED  

  • SALSIFY-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE  

Update Record

<salsify-connector-mule-4:update-record>

[Update one record](https://developers.salsify.com/reference#update-record). The URL must contain the Salsify record identifier as a parameter, and the record must already exist in Salsify. This operation makes an HTTP PUT request to the /orgs/{organizationId}/records/{recordId} endpoint

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Organization Id

String

Your organization id

x 

Record Id

String

The Salsify record identifier for this record.

x 

X Salsify Client Id

Enumeration, one of:

  • MULESOFT_V1_0_0

X Salsify Client Id

MULESOFT_V1_0_0

 

Body

Array of Any

the content to use

#[payload]

 

Config Ref

ConfigurationProvider

The name of the configuration to be used to execute this component

x 

Custom Query Parameters

Object

#[null]

 

Custom Headers

Object

#[null]

 

Response Timeout

Number

The timeout for request to the remote service.

 

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit which qualifies the Response Timeout}

 

Streaming Type

String

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

For Configurations

Throws

  • SALSIFY-CONNECTOR-MULE-4:BAD_REQUEST  

  • SALSIFY-CONNECTOR-MULE-4:CLIENT_ERROR  

  • SALSIFY-CONNECTOR-MULE-4:CONNECTIVITY  

  • SALSIFY-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR  

  • SALSIFY-CONNECTOR-MULE-4:NOT_ACCEPTABLE  

  • SALSIFY-CONNECTOR-MULE-4:NOT_FOUND  

  • SALSIFY-CONNECTOR-MULE-4:RETRY_EXHAUSTED  

  • SALSIFY-CONNECTOR-MULE-4:SERVER_ERROR  

  • SALSIFY-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE  

  • SALSIFY-CONNECTOR-MULE-4:TIMEOUT  

  • SALSIFY-CONNECTOR-MULE-4:TOO_MANY_REQUESTS  

  • SALSIFY-CONNECTOR-MULE-4:UNAUTHORIZED  

  • SALSIFY-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE  

Types

Proxy

Field Type Description Default Value Required

Host

String

Host where the proxy requests will be sent.

x

Port

Number

Port where the proxy requests will be sent.

x

Username

String

The username to authenticate against the proxy.

x

Password

String

The password to authenticate against the proxy.

x

Non Proxy Hosts

String

A list of comma separated hosts against which the proxy should not be used

x

Tls

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

Key Store

Revocation Check

Trust Store

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.

Key Store

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

Field Type Description Default Value Required

Only End Entities

Boolean

Only verify the last element of the certificate chain.

Prefer Crls

Boolean

Try CRL instead of OCSP first.

No Fallback

Boolean

Do not use the secondary checking method (the one not selected before).

Soft Fail

Boolean

Avoid verification failure when the revocation server can not be reached or is busy.

Custom Ocsp Responder

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 (must be in the trust store), if present.

Crl File

Field Type Description Default Value Required

Path

String

The path to the CRL file.

Reconnection

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 will fail if the test doesn’t pass after exhausting the associated reconnection strategy

Reconnection Strategy

The reconnection strategy to use

Reconnect

Field Type Description Default Value Required

Frequency

Number

How often (in ms) to reconnect

Blocking

Boolean

If false, the reconnection strategy will run in a separate, non-blocking thread

Count

Number

How many reconnection attempts to make

Reconnect Forever

Field Type Description Default Value Required

Frequency

Number

How often (in ms) to reconnect

Blocking

Boolean

If false, the reconnection strategy will run in a separate, non-blocking thread

Expiration Policy

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

A time unit that qualifies the maxIdleTime attribute

Http Response Attributes

Field Type Description Default Value Required

Status Code

Number

x

Headers

Object

x

Reason Phrase

String

x

Repeatable In Memory Stream

Field Type Description Default Value Required

Initial Buffer Size

Number

This is the amount of memory that will be allocated in order to consume the stream and provide random access to it. If the stream contains more data than can be fit into this buffer, then it will be expanded by according to the bufferSizeIncrement attribute, with an upper limit of maxInMemorySize.

Buffer Size Increment

Number

This is by how much will be buffer size by expanded if it exceeds its initial size. Setting a value of zero or lower will mean that the buffer should not expand, meaning that a STREAM_MAXIMUM_SIZE_EXCEEDED error will be raised when the buffer gets full.

Max Buffer Size

Number

This is the maximum amount of memory that will be used. If more than that is used then a STREAM_MAXIMUM_SIZE_EXCEEDED error will be raised. A value lower or equal to zero means no limit.

Buffer Unit

Enumeration, one of:

  • BYTE

  • KB

  • MB

  • GB

The unit in which all these attributes are expressed

Repeatable File Store Stream

Field Type Description Default Value Required

In Memory Size

Number

Defines the maximum memory that the stream should use to keep data in memory. If more than that is consumed then it will start to buffer the content on disk.

Buffer Unit

Enumeration, one of:

  • BYTE

  • KB

  • MB

  • GB

The unit in which maxInMemorySize is expressed