Skip to content

`ChangesetList_Load_Query`#

Description#

This function is used to load a list of Changesets from a specific template branch

Request Body Parameters#

Parameter	Type	Description
`count`	Number	Count is used to tell Miva how many records to return.
`offset`	Offset	Used in conjunction with the Count parameter for paginating results of large datasets. Default is `0`.
`sort`	String	Field to sort results by. Available sorting fields listed below. Use `-` prefix for a descending sort.
`filter`	Object	Array of Object containing search filters. See usage here
#filter)

Search Filter	Description
`id`	Changeset ID

Supported Sort Columns#

One of these values would be passed in the sort request parameter to have the results sorted by that column. Value may be preceded by - for a descending sort.

Sort	Description
`id`	Changeset ID

Response Parameters#

Parameter	Type	Description
`total_count`	Number	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`	Number	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`	Number	Changeset ID
`branch_id`	Number	Branch ID
`user_id`	String	ID of the admin user who created the changeset.
`dtstamp`	Unix Timestamp	Date/Timestamp
`notes`	String	Notes Associated with the changeset
`tags`	Array	Array of any tags associated with the changeset
`formatted_tags`	String	List of all tags including #
`user_name`	String	username of the admin user who created the changeset.

Example Request#

{
    "Store_Code": "{{Store_Code}}",
    "Miva_Request_Timestamp": "{{$timestamp}}",
    "Function": "ChangesetList_Load_Query",
    "Branch_Name": "Dev Branch 1",
    "Count": 0,
    "Offset": 0,
    "Sort": "-id",
    "Filter": []
}

Example Response#

{
    "success": 1,
    "data": {
        "total_count": 7,
        "start_offset": 0,
        "data": [
            {
                "id": 38,
                "branch_id": 5,
                "user_id": 25,
                "dtstamp": 1596656385,
                "notes": "CSS Resource 'google-fonts' attributes updated",
                "tags": [],
                "formatted_tags": "",
                "user_name": "mivalearn"
            },
            {
                "id": 34,
                "branch_id": 5,
                "user_id": 1,
                "dtstamp": 1596636456,
                "notes": "JavaScript Resource 'scripts' attributes updated",
                "tags": [],
                "formatted_tags": "",
                "user_name": "administrator"
            },
            {
                "id": 33,
                "branch_id": 5,
                "user_id": 1,
                "dtstamp": 1596636436,
                "notes": "JavaScript Resource 'scripts' SRI attributes generated",
                "tags": [],
                "formatted_tags": "",
                "user_name": "administrator"
            },
            {
                "id": 31,
                "branch_id": 5,
                "user_id": 0,
                "dtstamp": 1596579069,
                "notes": "Copied from branch 'Dev Branch 1': ReadyTheme Image 'storefront_hero_image' updated",
                "tags": [],
                "formatted_tags": "",
                "user_name": ""
            },
            {
                "id": 30,
                "branch_id": 5,
                "user_id": 1,
                "dtstamp": 1596578707,
                "notes": "Reverted To: Branch 'Dev Branch 1' created",
                "tags": [],
                "formatted_tags": "",
                "user_name": "administrator"
            },
            {
                "id": 29,
                "branch_id": 5,
                "user_id": 1,
                "dtstamp": 1596578687,
                "notes": "ReadyTheme Image 'storefront_hero_image' updated",
                "tags": [],
                "formatted_tags": "",
                "user_name": "administrator"
            },
            {
                "id": 20,
                "branch_id": 5,
                "user_id": 1,
                "dtstamp": 1596565084,
                "notes": "Branch 'Dev Branch - 1' created",
                "tags": ["checkout_redesign"],
                "formatted_tags": "#checkout_redesign",
                "user_name": "administrator"
            }
        ]
    }
}