The Javascript API (JS API) asset is used to enable the execution of core-level Squiz Matrix functions using JavaScript, allowing users to create, modify and retrieve content within the system. These functions are handled on the Details screen of the Javascript API asset. For more information, refer to the Details Screen section of this chapter.

Due to cross domain AJAX request and session restrictions, the JavaScript API should not be used if your configuration requires cross domain calls.

Once you have added a Javascript API asset, you can configure its settings on its associated asset screens. The majority of these screens are the same or similar to those for a Standard Page and are described in the Asset Screens manual. In this chapter, we will describe the Details screen, which is different for the Javascipt API.

Details Screen

The Details screen allows you to configure the operation parameters and restrictions of the Javascript API. For more information about the Status, Future Status, Thumbnail and Details sections, refer to the Details Screen chapter in the Asset Screens manual.

Restrictions

This section allows you to set restrictions for the Javascript API operations.

The fields available are as follows:

• Root Node: Select a root node to restrict the Javascript API to. This will limit the API's functions to that specific root node. For example, if your system contains two Sites, Site 1 and Site 2, selecting Site 1 in this field will only allow the Javascript API to access the content of that specific Site. To select additional Root Nodes, click the More… button. To delete a root node from the list, click the Clear button. This field is mandatory.
• Asset Types to Create: Select asset types to restrict the assets that can be created by the createAsset operation. For example, selecting Cart in this field will mean that the createAsset operation will only be able to create Cart assets. To select more than one asset type, click on the More… button. An additional list will appear on the screen. To remove an asset type from the list, click the Clear button and click Commit.
• Parent Types: Select asset types to restrict the assets that can act as parents when using creation, linking and moving operations. For example, selecting Site in this field will mean that an operation involving a parent asset, such as createAsset or createLink, will only allow the Javascript API to use Site assets as the parent asset.
• Allow Attributes on Create: Select whether or not additional attributes can be added when creating assets using the createAsset operation. If this field is set to Yes, the attribute parameter of the createAsset operation can be used to define attributes to be added. For example, a News Item asset can be created with the attribute parameter as contact_name=John&contact_phone=01234. This will set the Contact name attribute of the News Item to John and the Contact phone attribute to 01234. By default, this field is set to No.
• Return JSON: Select whether or not to return result codes via JSON in response to the Javascript API's operations. You may choose to disable the return of JSON to prevent users from being able to view information, such as asset IDs and attribute values, from certain operations. By default, this field is set to Yes.
• Ignore Permissions: Select whether or not to ignore Permissions when creating assets using the createAsset, cloneAsset and createFileAsset operations. If this field is set to Yes, Permissions will not be checked when performing these functions. This means that a user without the appropriate Write Access would still be able to create an asset within the system. By default, this field is set to No.
• Force Simple Edit: By default, the function calls of the Javascript API will act as if made on the Administration Interface of Squiz Matrix. This means that any generated URLs, for example, in a workflow email, will contain the _admin suffix. This field allows you to force function calls to act as if made in the Simple Edit Interface, meaning that any URLs generated by these calls would use the _edit suffix instead of the _admin suffix. By default, this field is set to No.
• Use Enhanced JS API: Leave this as Yes. Setting it to No will use the Standard Mode on the JS API which has been deprecated as of version 5.1.0.0 and is a much inferior version.
• Allow Batching Requests: The batchRequest operation. This operation allows you to group multiple functions on the JS API into a single request. By default, this field is set to No. For more information, refer to the Batching Requests section in this chapter.

API Settings

This section contains the API Key used for the Javascript API asset. The Squiz_Matrix_API construct defined on the API uses this key in order to allow the Javascript API assets to function.

For more information, refer to the Basic Javascript API Implementation chapter in this manual.

Core

This section displays the available Core operations.

The following operations are displayed in this section:

• Create Asset: the createAsset and createFileAsset operations. The createAsset operation will create an asset in the system, while the createFileAsset operation will create a blank File type asset (PDF File, MP3 etc.) that users will be able to upload their file to.
• Clone Asset: the cloneAsset operation. This will clone an asset under a specified parent.
• Get General Info: The getGeneral and getChildCount operations. The getGeneral operation will return the general information of an asset, while the getChildCount operation will return a count of the number of direct children and/or dependants of an asset
• Get Asset Types: the getAssetTypes operation. This will return the asset type codes of assets within the system.
• Get Attributes: the getAttributes operation. This will return the attributes of an asset.
• Set Attribute: the setAttribute and setMultipleAttributes operations. These will set either a single attribute value or multiple attribute values on an asset.
• Get Lock Info: the getLocksInfo operation. This will return the general information of locks on an asset.
• Acquire Lock: the acquireLock operation. This will acquire the lock of an asset screen (or update the lock if it has already been acquired by the user).
• Release Lock: the releaseLock operation. This will release the lock of an asset screen.
• Trash Asset: the trashAsset operation. This will send an asset to the Trash.
• Get Keyword Replacements: the getKeywordsReplacements operation. This will return the standard and global keyword replacements of an asset.
• Set Asset Status: the setAssetStatus operation. This will set the Status of an asset and its dependants (with the option of cascading the Status to child assets).
• Get Asset WebPath(s): the getWebPath operation. This will return the web path(s) of an asset.
• Set Asset WebPath: the setWebPath operation. This will set the web path of an asset.
• Get Roles Information: the getRoles operation. This will return the roles of an asset.
• Set File Content: the setContentOfEditableFileAsset operation. This will set the content of an editable File type asset (CSS File, XML File, Text File, XSL File, JS File). Please note that locks need to be acquired on the asset before setting content.
  • Update File Content: the updateFileAssetContent operation. This function is automatically enabled on the JS API details screen together with the Set File Content function. This will update the contents of a File type asset by passing the data in a base64 encoded string. Please note that locks need to be acquired on the asset before setting content.
• Import Assets from XML: the importAssetsFromXML operation. This will import assets under a specified root node from a structured XML file.
• Execute HTML Tidy: the executeHTMLTidy operation. This will execute HTML Tidy on the content of a passed string.
• Show Content Differences: the showDifference operation. This will compare the content of two different assets.
• Validate Active User: the validateActiveUser operation. This will validate a specified user and can optionally return the asset IDs of user groups the user belongs to.
• Get File Indexing Components: the getFileIndexingComponents operation. This will fetch indexing contents for file assets that would normally be served by Apache. The returned data includes details about metadata values, file properties and permission details.
• Sort Asset Children: the sortAssetChildren operation. This will sort child assets of a particular asset in a specific order and sorted by a specific value.

For the parameters required for each operation, refer to the Operation Parameters section of this chapter.

Linking

This section displays the available Linking operations.

The following operations are displayed in this section:

• Create Link: the createLink operation. This will create a link in the system.
• Remove Link: the removeLink and removeMultipleLinks operations. These will remove either a single link or multiple links between a parent and child asset.
• Move Link: the moveLink operation. This will move a link from one parent to another.
• Update Link: the updateLink and updateMultipleLinks operations. These will update either a single link or multiple links in the system.
• Get Link Id: the getLinkId operation. This will return the link id between a parent and child asset.

For the parameters required for each operation, refer to the Operation Parameters section of this chapter.

Permissions

This section displays the available Permissions operations.

The following operations are displayed in this section:

• Get Permissions: the getPermissions operation. This will return the permissions of an asset.
• Set Permissions: the setPermission operation. This will set a User or User Group permission on a specified asset.

For the parameters required for each operation, refer to the Operation Parameters section of this chapter.

Workflow

This section displays the available Workflow operations.

The following operations are displayed in this section:

• Get Workflow Schema: the getWorkflowSchema operation. This will return any applied or denied workflow schemas on an asset.

For the parameters required for each operation, refer to the Operation Parameters section of this chapter.

Traversing

This section displays the available Traversing operations.

The following operations are displayed in this section:

• Get Parents: the getParents operation. This will return the parents of an asset.
• Get Children: the getChildren operation. This will return the dependant, non-dependant and NOTICE linked children of an asset.
• Get Asset Tree: the getAssetTree operation. This will return tree information for children of an asset.
• Get Lineage: the getLineage operation. This will return the asset lineages of an asset.
• Get Lineage From URL: the getLineageFromUrl operation. This will return the asset lineage of a specified URL.
• Get URL From Lineage: the getUrlFromLineage operation. This will return the URL of an asset lineage.

For the parameters required for each operation, refer to the Operation Parameters section of this chapter.

Metadata

This section displays the available Metadata operations.

The following operations are displayed in this section:

• Get Metadata: the getMetadata operation. This will return the metadata values of an asset.
• Set Metadata: the setMetadata and SetMetadataAllFields operations. The SetMetadata operation will set a metadata value for an asset while the SetMetadataAllFields operation will set the metadata values of multiple fields for an asset.
• Get Metadata Schema: the getMetadataSchema operation. This will return the details of the metadata schema(s) configured on an asset, including metadata fields and their attributes.
• Edit Metadata Schema: the editMetadataSchema operation. This will set or unset a metadata schema on a specified asset.

For the parameters required for each operation, refer to the Operation Parameters section of this chapter.

Google Analytics

System Information

Form Questions

Operation Parameters

The parameters of the operations managed by the Javascript API are detailed below.

createAsset

*NOTE: The link_type parameter can accept the value as a string or its integer value:

**NOTE: This parameter requires the Allow Attributes on Create field enabled. For more information, refer to the Restrictions section of this chapter.

Example

js_api.createAsset({
   "parent_id":100,
   "type_code":"comment",
   "asset_name":"blog comment",
   "link_type":"SQ_LINK_TYPE_1",
   "link_value":"link value",
   "sort_order":1,
   "is_dependant":0,
   "is_exclusive":0,
   "extra_attributes":1,
   "attributes":"comment=comment goes here&rating=5.0",
   "dataCallback":customDataCallbackFunc
}) 

createFileAsset

*NOTE: The link_type parameter can accept the value as a string or its integer value:

Example

js_api.createFileAsset({
   "parentID":"100",
   "type_code":"pdf_file",
   "friendly_name":"my-file",
   "link_type":"SQ_LINK_TYPE_1",
   "link_value":"link value",
   "dataCallback":customDataCallbackFunc
}) 

cloneAsset

Example

js_api.cloneAsset({
   "asset_id":"100",
   "new_parent":"240",
   "clone_name":"name",   
   "clone_num":2,
   "new_position":1,
   "link_type":"SQ_LINK_TYPE_2",
   "link_value":"new value",
   "dataCallback":customDataCallbackFunc
})

getGeneral

Example

js_api.getGeneral({
   "asset_id":"100",
   "get_attributes":1,
   "dataCallback":customDataCallbackFunc
}) 

getChildCount

Example

js_api.getChildCount({
   "asset_id":"100",
   "level":5,
   "dataCallback":customDataCallbackFunc
}) 

getAssetTypes

Example

js_api.getAssetTypes({
   "dataCallback":customDataCallbackFunc
}) 

getAttributes

Example

js_api.getAttributes({
   "asset_id":"100",
   "dataCallback":customDataCallbackFunc
}) 

setAttribute

Example

js_api.setAttribute({
   "asset_id":"100",
   "attr_name":"name",
   "attr_val":"new title",
   "dataCallback":customDataCallbackFunc
}) 

js_api.setAttribute({
   "asset_id":"100",
   "attr_name":"html",
   "attr_val":"content",
   "dataCallback":customDataCallbackFunc
}) 

setMultipleAttributes

Example

js_api.setMultipleAttributes({
   "asset_id":"100",
   "field_info":{
      "name":"New Name",
      "short_name":"New Short Name"
   },
   "dataCallback":customDataCallbackFunc
}) 

getLocksInfo

Available screen name (lock types) that you can get lock info for are:

Example

js_api.getLocksInfo({
   "asset_id":"100",
   "screen_name":"settings",
   "dataCallback":customDataCallbackFunc
}) 

acquireLock

Example

js_api.acquireLock({
   "asset_id":"100",
   "screen_name":"metadata",
   "dependants_only":0,
   "force_acquire":1,
   "dataCallback":customDataCallbackFunc
}) 

The Details Screen of an Asset consists of both the Attributes and Links locks.

releaseLock

Example

js_api.releaseLock({
   "asset_id":"100",
   "screen_name":"links",
   "dataCallback":customDataCallbackFunc
}) 

trashAsset

Example

js_api.trashAsset({
   "asset_ids":[
      "100",
      "101",
      "102"
   ],
   "dataCallback":customDataCallbackFunc
}) 

getKeywordsReplacements

Example

js_api.getKeywordsReplacements({
   "asset_id":"100",
   "keywords_array":[
      "%asset_name%",
      "%asset_assetid%"
   ],   "null_if_empty":true, 
   "dataCallback":customDataCallbackFunc
}) 

setAssetStatus

You can view the status numbers for the status parameter on the Squiz Matrix Concepts chapter of the Concepts manual.

Example

js_api.setAssetStatus({
   "asset_id":"100",
   "status":32,
   "cascade":1,
   "workflow_stream":"altstream",
   "userlog":"log message",   "dataCallback":customDataCallbackFunc
}) 

getWebPath

Example

js_api.getWebPath({
   "asset_id":"100",
   "dataCallback":customDataCallbackFunc
}) 

setWebPath

Example

js_api.setWebPath({
   "asset_id":"100",
   "paths":[
      "about-us",
      "about",
      "info"
   ],
   "auto_remap":1,
   "dataCallback":customDataCallbackFunc
}) 

getRoles

Example

js_api.getRoles({
   "asset_id":100,
   "role_id":150,
   "user_id":70,
   "include_assetid":1,
   "include_globals":1,
   "expand_groups":1,
   "inc_dependants":0,
   "include_parents":0,   "type_codes":"page",   "strict_type_code":0,   "dataCallback":customDataCallbackFunc
})  

setContentOfEditableFileAsset

Example

js_api.setContentOfEditableFileAsset({
   "asset_id":"100",
   "content":"content of file",
   "dataCallback":customDataCallbackFunc
}) 

js_api.updateFileAssetContent({
   "asset_id":"100",
   "content":"/9j/4QDGRXhpZgAASUkqAAgAA...",
   "dataCallback":customDataCallbackFunc
}) 

importAssetsFromXML

Example

js_api.importAssetsFromXML({
   "asset_id":"100",
   "filePath":"/path/to/our/xml/file/import_from_this_file.xml",
   "dataCallback":customDataCallbackFunc
}) 

executeHTMLTidy

Example

js_api.executeHTMLTidy({
   "content":"<h1>heading</h2>",
   "dataCallback":customDataCallbackFunc
}) 

showDifference

Example

js_api.showDifference({
   "assetid_1":"100",
   "assetid_2":"200",
   "paint_layout_1":"340",
   "paint_layout_2":"350",
   "dataCallback":customDataCallbackFunc
}) 

validateActiveUser

js_api.validateActiveUser({
   "username":"User",
   "get_groups":1,   "dataCallback":customDataCallbackFunc
}) 

getFileIndexingComponents

js_api.getFileIndexingComponents({
   "asset_urls":"http://www.example.com/__data/assets/thumbnail/0019/955/img.jpg",
   "dataCallback":customDataCallbackFunc
}) 

js_api.sortAssetChildren({
   "parent_id":     "100",
   "sort_by":       "type_code",
   "sort_direction: "ascending",
   "sort_type":     0,
   "dataCallback":  customDataCallbackFunc
})

createLink

*NOTE: The link_type parameter can accept the value as a string or its integer value:

Example

js_api.createLink({
   "parent_id":100,
   "child_id":120,
   "link_type":"SQ_LINK_TYPE_2",
   "link_value":"link_value",
   "sort_order":1,
   "is_dependant":1,
   "is_exclusive":0,
   "dataCallback":customDataCallbackFunc
}) 

removeLink

Example

js_api.removeLink({
   "parent_id":"100",
   "child_id":"120",
   "link_type":"SQ_LINK_TYPE_1",
   "link_value":"link value",
   "dataCallback":customDataCallbackFunc
}) 

removeMultipleLinks

Example

js_api.removeMultipleLinks({
   "link_info":{
      "links":[
         {
            "parent":"100",
            "child":"120",
            "link_type":"SQ_LINK_TYPE_1",
            "link_value":"link value"
         },
         {
            "parent":"200",
            "child":"220",
            "link_type":"SQ_LINK_TYPE_1",
            "link_value":"link value"
         }
      ]
   },
   "dataCallback":customDataCallbackFunc
})

moveLink

Example

js_api.moveLink({
   "old_parent_id":"100",
   "child_id":"120",
   "old_link_type":"SQ_LINK_TYPE_1",
   "old_link_value":"old link value",
   "new_parent_id":"200",
   "new_link_type":"SQ_LINK_TYPE_1",
   "new_link_value":"new link value",
   "new_position":"1",
   "dataCallback":customDataCallbackFunc
}) 

updateLink

Example

js_api.updateLink({
   "parent_id":"100",
   "child_id":"120",
   "existing_link_type":"SQ_LINK_TYPE_1",
   "existing_link_value":"current link value",
   "link_type":"SQ_LINK_TYPE_2",
   "link_value":"new link value",
   "sort_order":"10",
   "locked":"1",
   "dataCallback":customDataCallbackFunc
}) 

updateMultipleLinks

Example

js_api.updateMultipleLinks({
   "link_info":{
      "links":[
         {
            "parent":"100",
            "child":"120",
            "existing_link_type":"SQ_LINK_TYPE_1",
            "existing_link_value":"old link value",
            "link_type":"SQ_LINK_TYPE_2",
            "link_value":"new link value",
            "sort_order":"5",
            "link_lock":"1"
         },
         {
            "parent":"200",
            "child":"220",
            "existing_link_type":"SQ_LINK_TYPE_2",
            "existing_link_value":"old link value",
            "link_type":"SQ_LINK_TYPE_1",
            "link_value":"new link value",
            "sort_order":"2",
            "link_lock":"0"
         }
      ]
   },
   "dataCallback":customDataCallbackFunc
}) 

getLinkId

Example

js_api.getLinkId({
   "asset_id":"100",
   "child_id":"120",
   "link_type":"SQ_LINK_TYPE_!",
   "link_value":"link_value",
   "all_info":1,
   "dataCallback":customDataCallbackFunc
}) 

getPermissions

Example

js_api.getPermissions({
   "asset_id":"100",
   "level":"3",
   "dataCallback":customDataCallbackFunc
}) 

setPermission

js_api.setPermission({
   "asset_id":"123",
   "user_ids":"456",
   "granted":"1",
   "level":"3",
   "cascades":"true",
   "dependants_only":"true",
   "dependants_parents":"false",
   "dataCallback":customDataCallbackFunc
})

getWorkflowSchema

Example

js_api.getWorkflowSchema({
   "asset_id":"100",
   "granted":1,
   "running":0,
   "dataCallback":customDataCallbackFunc
}) 

getParents

Example

js_api.getParents({
   "asset_id":"100",
   "levels":3,
   "type_codes":[
      "page_standard",
      "site"
   ],
   "link_types":[
      "SQ_LINK_TYPE_1",
      "SQ_LINK_TYPE_2"
   ],
   "link_values":[
      "value1",
      "value2"
   ],
   "get_attributes":1,
   "dataCallback":customDataCallbackFunc
}) 

getChildren

Example

js_api.getChildren({
   "asset_id":"100",
   "levels":2,
   "type_codes":[
      "page_standard",
      "comment"
   ],
   "link_types":[
      "SQ_LINK_TYPE_1",
      "SQ_LINK_TYPE_2"
   ],
   "link_values":[
      "value1",
      "value2"
   ],
   "get_attributes":1,
   "dataCallback":customDataCallbackFunc
}) 

getAssetTree

Example

js_api.getAssetTree({
   "asset_id":"100",
   "levels":2,
"link_types":1,   "dataCallback":customDataCallbackFunc
})

getLineage

Example

js_api.getLineage({
   "asset_url":"http://www.example.com/site",
   "significant_links_only":1,
   "dataCallback":customDataCallbackFunc
}) 

js_api.getLineage({
   "asset_url":"100",
   "significant_links_only":0,
   "dataCallback":customDataCallbackFunc
})  

getLineageFromUrl

js_api.getLineageFromUrl({
   "asset_url":"http://www.example.com/site",
   "dataCallback":customDataCallbackFunc
}) 

getUrlFromLineage

js_api.getUrlFromLineage({
   "lineage":["4206", "4437"],
   "root_url":"http://www.example.com/site ",   "protocol":"https",
   "dataCallback":customDataCallbackFunc
})

getMetadata

Example

js_api.getMetadata({
   "asset_id":"100",
   "dataCallback":customDataCallbackFunc
}) 

setMetadata

*NOTE: The formats for setting the various metadata field types are outlined below. Please note that you can pass a value of null to use the default metadata value on the specified field.

• Text: a simple text string, e.g. Squiz Matrix.
• Select: the key(s) for the option(s) to select, separated by semicolons, e.g. a; b; c.
• Multiple Text: simple text strings, separated by semicolons for each item, e.g. Squiz; Matrix.
• Date: the date and time in the format yyyy-MM-dd hh:mm:ss, e.g. 2012-06-14 09:12:40.
• Thesaurus: the name of the Thesaurus Term, e.g. Matrix.
• Hierarchy: the key(s) for the option(s) to select, separated by semicolons, e.g. a; a1; b2.
• WYSIWYG: HTML content, e.g. <strong>lorem ipsum...</strong>
• Related Asset: the asset ID of the related asset, e.g. 123.

For more information on the metadata field types available, refer to the Metadata Schemas manual.

Example

js_api.setMetadata({
   "asset_id":100,
   "field_id":900,
   "field_val":"metadata",
   "dataCallback":customDataCallbackFunc
}) 

js_api.setMetadata({
   "asset_id":100,
   "field_id":900,
   "field_val":null,
   "dataCallback":customDataCallbackFunc
}) 

setMetadataAllFields

Example

js_api.setMetadataAllFields({
   "asset_id":"100",
   "field_info":{
      "900":"Metadata1",
      "901":"Metadata2"
   },
   "dataCallback":customDataCallbackFunc
})   

getMetadataSchema

js_api.getMetadataSchema({
   "assetid":"150",
   "granted":1,   "cascades":0,   "dataCallback":customDataCallbackFunc
})  

editMetadataSchema

js_api.editMetadataSchema({
   "assetid":"612",
   "schemaid":"405",
   "set":1,
   "granted":0,
   "cascades":0,   "dataCallback":customDataCallbackFunc
})  

getAlternateContext

js_api.getAlternateContext({
   "all_info":1,
   "dataCallback":customDataCallbackFunc
})

getCurrentContext

js_api.getCurrentContext({
   "all_info":1,
   "dataCallback":customDataCallbackFunc
})

getAllContexts

js_api.getAllContexts({
   "all_info":1,
   "dataCallback":customDataCallbackFunc
}) 

setContext

js_api.setContext({
   "context_id":"160",
   "dataCallback":customDataCallbackFunc
}) 

restoreContext

js_api.restoreContext({
   "dataCallback":customDataCallbackFunc
}) 

js_api.contextualiseAsset({
  "asset_id":"100"
  "context_id":"1"
  "contextualise":true
  "component_type":"metadata"
  "dataCallback":customDataCallbackFunc
})

getGoogleAnalyticsStatistics

js_api.getGoogleAnalyticsStatistics({
   "assetid":"100",
   "dimensions":["ga:date"],
   "metrics":["ga:sessions", "ga:pageviews"],
   "duration":"P1M",
   "end_date":"-P1D",
   "sort_by":["-ga:sessions"],   "dataCallback":customDataCallbackFunc
}) 

getSystemInformation

js_api.getSystemInformation({
   "dataCallback":customDataCallbackFunc
}) 

createQuestion

js_api.createQuestion({
    "assetid":"100",
    "type_code":"Country",    "units":2,
    "dataCallback":customDataCallbackFunc
}) 

updateQuestion

var field_info = {
    'cust_required_error': 'This is custom Text',                                                     //text type
    'is_required': 1,                                                                                 // boolean type
    'default':  '2014-10-10 10:59:39',                                                                // datetime type
    'name': 'Date Time Question',                                                                     // text type
    'show': show_array,                                                                               // serialise type
    'text': 'a:3:{s:1:"d";s:9:"date text";s:1:"m";s:10:"month text";s:1:"y";s:9:"year text";}'        // also serialise type
};

js_api.updateQuestion({
    "assetid":"100",
    "question_id":"q35",
    "field_info":field_info,
    "dataCallback":customDataCallbackFunc})

removeQuestion

js_api.removeQuestion({
    "assetid":"100",
    "question_id":"q35",
    "dataCallback":customDataCallbackFunc})

updateQuestionOrder

question_order = ['100:q52', '100:q51', '100:q50', '100:q49''];
js_api.updateQuestionOrder({
    assetid:"100",
    sort_order:question_order,
    dataCallback:customDataCallbackFunc})

getAvailablePersonas

Example

js_api.getAvailablePersonas({
  "asset_id":"100",
  "dataCallback":customDataCallbackFunc<br>
})

assignPersonas

Example

js_api.assignPersona({
  "asset_id":"100",
  "variation_id":"101"
  "persona_ids": ["200"]
  "dataCallback":customDataCallbackFunc
})

Batching Requests

The batchRequest operation allows you to group multiple functions on the JS API into a single batched request. The response of this operation will include all the data returned from each executed function.

The output of functions on this operation can be used as the input for subsequent functions using the following keyword replacement format:

%results_0_<param>%

For example, the keyword replacement %results_0_1_name% would print the value of the name parameter returned on the second element of the first array of the response.

Please note that Squiz Matrix will attempt to replace this keyword when used within page content returning a blank value. In such cases, the following format for this keyword can be employed:

"%" + "results_0_<param>" + "%"

A blocking parameter (type: boolean) is available for use on each operation to stop the execution of subsequent operations if an error is returned. Usage of this parameter is as follows:

{ 
    function :"getGeneral", 
    args : { 
        asset_id : "100", 
        get_attributes : 0
    } 
"blocking":1
} 

Example

In the following example, we are using the batchRequest operation to run the getChildren and setAttribute operations on a single request.

The getChildren operation will retrieve the top level child assets of our Site (#100) that are of type page_standard. The setAttribute operation will use this information to change the short_name of the first returned asset on this response.

To do this, we have used the %results_0_0_id% keyword replacement in the asset_id paramater. This will retrieve the id value of the first element of the first array of the response (i.e. the first returned asset on the data returned on the getChildren operation).

The blocking property has also been used on the getChildren operation. This means that if an error is returned, the following operation (setAttribute) will not be run.

Request (Enhanced)

js_api.batchRequest({
   "functions":{
      "0":{
         "function":"getChildren",
         "args":{
         "asset_id":"100",
         "levels":1,
         "type_codes":"page_standard",
         "get_attributes":0
         },
         "blocking":1
      },
      "1":{
         "function":"setAttribute",
         "args":{
         "asset_id":"%results_0_0_id%",
         "attr_name":"short_name",
         "attr_val":"new short name"
         }
      }
   },
   "dataCallback":customDataCallbackFunc
}); 

Response

[["0" { 
        "name" : Home Page 
        "short_name" : Home 
        "id" : 150
        "type_code" : page_standard 
        "type" : Page Standard
        ... 

   }, 

["Attribute "short_name" has been successfully set to "new short name" for Asset "Home Page" (#150)"]]  

As shown in the above response, the batchRequest operation has used the returned id value on getChildren (first element) as the asset ID passed in the setAttribute operation.