platform/extensions

Use the Extensions resource to manage Arc.js configuration settings. These are the same settings you can configure through Admin in the Action Management JSON Editor.

JSON Example

TenantExtensions Properties

Property Description
actions

type: list of customFunctionsForAction

The list of actions configured for the site.

customFunctionsForAction.actionId

type: string

The full action ID for a specific action.

customFunctionsForAction.contexts

type: list of customFunctionsForContext

An array of settings for a particular action.

customFunctionsForAction.customFunctionsForContext.context

type: int

The site ID for the site you want to apply a group of settings to. You do not need to provide this value if you want to apply the same settings to a particular action across all your sites.

customFunctionsForAction.customFunctionsForContext.customFunctions

type: list of customFunction

An array of custom functions tied to a particular action.

customFunctionsForAction.customFunctionsForContext.customFunction.applicationKey

type: string

The Arc.js application key.

customFunctionsForAction.customFunctionsForContext.customFunction.configuration

type: Mozu.Core.Api.Contracts.Json

Custom function-level settings specified as key-value pairs.

customFunctionsForAction.customFunctionsForContext.customFunction.enabled

type: bool

Indicates if a capability, function tied to an Arc.js action, application, or price list is enabled for the tenant/site. If true, the capability/application/function/price list is enabled for the tenant. System-supplied and read-only with the exception of functions tied to an Arc.js action and price lists.

customFunctionsForAction.customFunctionsForContext.customFunction.exceptionBehavior

type: string

The behavior to take when an error is encountered. "fault" or "continue". The default is "fault".

customFunctionsForAction.customFunctionsForContext.customFunction.functionId

type: string

The name of the custom function tied to a particular action.

customFunctionsForAction.customFunctionsForContext.customFunction.logLevel

type: string

The priority level to assign to logs related to a particular function. Possible values mirror Apache's log4net: "all", "debug", "info", "warn", "error", "fatal", and "off".

customFunctionsForAction.customFunctionsForContext.customFunction.timeoutMilliseconds

type: int

The number of milliseconds that the function waits before timing out. The default is 5000 milliseconds

configurations

type: list of extensionConfiguration

An array of settings that apply to all actions within the application.

extensionConfiguration.applicationKey

type: string

The Arc.js application key.

extensionConfiguration.configuration

type: Mozu.Core.Api.Contracts.Json

Custom application-level settings specified as key-value pairs.

defaultLogLevel

type: string

The priority level to assign to application logs. Possible values mirror Apache's log4net: "all", "debug", "info", "warn", "error", "fatal", and "off".

Operations

Operation Name Request URI Description
GetExtensions GET %3fresponseFields%3d%7bresponseFields%7d

Retrieves the Arc.js configuration settings for a site.

UpdateExtensions PUT %3fresponseFields%3d%7bresponseFields%7d

Updates the Arc.js configuration settings for a site.