24/7 Support: 800.608.6482

Navigation


ResourceGroupList_Load_Query

This function is used pull resource groups and any linked css or JS to each group for a specific Branch.

An Optional Changeset_ID may be passed.

Request Body Parameters

count Type:
Number
Title:
Count
Count is used to tell Miva how many resource groups you want returned. If for example you are querying thousands of resource groups you'll want to set the count to limit how many you get back in a single request.
offset Type:
Offset
Title:
Number
Used in conjunction with the Count parameter for paginating results of large datasets. Default is 0 whcih is no offset.
sort Type:
String
Title:
Sort
Field to sort results by. Avaiilable sorting fields listed above. Use - prefix for a decending sort.
Filter Type:
Object
Title:
Filter
Array of Object containing search filters. See usage here: List Load Query Overview
Branch_Name Type:
String
Title:
Branch Name
Name of Branch you want to pull resource groups from
Changeset_ID Type:
Number
Title:
Changeset ID
Optional Changeset ID. If omitted, the response will include templates from the head of the Branch

On Demand Columns

linkedcssresources
linkedjavascriptresources

Response Parameters

total_count Type:
Number
Title:
Total Product Count
total_count is the total number of records that match your search criteria. Note: this is not always the total products returned. Based on the Count and Offset parameters passed, the number of records returned could be different than the total_count.
start_offset Type:
Number
Title:
Start Offset
Number number of the starting offset number of branches to return. Used in conjunction with the Count parameter for paginating results of large datasets.
id Type:
Number
Title:
Resource ID
Resource ID
code Type:
String
Title:
Resource Code
Resource Code
linkedcssresources
+ Show Properties
Type:
Object
Title:
Linked CSS Resources
This object is an array of all linked CSS Resources
linkedjavascriptresources
+ Show Properties
Type:
Object
Title:
Linked JavaScript Resources
This object is an array of all linked JavaScript Resources

Example Request

Example Response

This website uses cookies to identify visitors, track visitors to our website, store login session information and to remember your user preferences. By continuing to use this site you agree to our use of cookies. Learn More.

This website uses cookies. By continuing to use this site you agree to our use of cookies. Learn More.

Accept

Copyright © 1997 – 2023 Miva©, Miva Merchant©, MivaPay©, MivaCon©, Camp Miva ℠, Miva, Inc. All Rights Reserved.