Let the platform do the work
SugarClubContact+1 (877) 842-7276

//:root/tree GET

Overview

Retrieves full tree for selected root record.

Request Arguments

Name Type Description Required
module String The name of sugar module that contains a nested set data and implements the NestedSetInterface. True
:record String The ID of record True

Response Arguments

This endpoint does not return any response arguments.

Response

{
"next_offset": -1,
"records": [{
    "id": "ad4ddf76-327a-11e4-818b-5404a67f3363",
    "name": "Documents",
    "date_entered": null,
    "date_modified": null,
    "modified_user_id": null,
    "created_by": null,
    "description": null,
    "deleted": "0",
    "source_id": null,
    "source_type": null,
    "source_meta": null,
    "root": "935d3e07-327a-11e4-818b-5404a67f3363",
    "lft": "2",
    "rgt": "9",
    "level": "1",
    "children": {
        "next_offset": -1,
        "records": [{
            "id": "ad4e03f1-327a-11e4-818b-5404a67f3363",
            "name": "Engeneering",
            "date_entered": null,
            "date_modified": null,
            "modified_user_id": null,
            "created_by": null,
            "description": null,
            "deleted": "0",
            "source_id": null,
            "source_type": null,
            "source_meta": null,
            "root": "935d3e07-327a-11e4-818b-5404a67f3363",
            "lft": "3",
            "rgt": "4",
            "level": "2",
            "children": {
                "next_offset": -1,
                "records": []
            }
        }, {
            "id": "f482dd1b-327a-11e4-818b-5404a67f3363",
            "name": "Testing",
            "date_entered": null,
            "date_modified": null,
            "modified_user_id": null,
            "created_by": null,
            "description": null,
            "deleted": "0",
            "source_id": null,
            "source_type": null,
            "source_meta": null,
            "root": "935d3e07-327a-11e4-818b-5404a67f3363",
            "lft": "5",
            "rgt": "6",
            "level": "2",
            "children": {
                "next_offset": -1,
                "records": []
            }
        }, {
            "id": "f482fb7a-327a-11e4-818b-5404a67f3363",
            "name": "Management",
            "date_entered": null,
            "date_modified": null,
            "modified_user_id": null,
            "created_by": null,
            "description": null,
            "deleted": "0",
            "source_id": null,
            "source_type": null,
            "source_meta": null,
            "root": "935d3e07-327a-11e4-818b-5404a67f3363",
            "lft": "7",
            "rgt": "8",
            "level": "2",
            "children": {
                "next_offset": -1,
                "records": []
            }
        }]
    }
}, {
    "id": "045c03b9-327b-11e4-818b-5404a67f3363",
    "name": "Audit",
    "date_entered": null,
    "date_modified": null,
    "modified_user_id": null,
    "created_by": null,
    "description": null,
    "deleted": "0",
    "source_id": null,
    "source_type": null,
    "source_meta": null,
    "root": "935d3e07-327a-11e4-818b-5404a67f3363",
    "lft": "10",
    "rgt": "19",
    "level": "1",
    "children": {
        "next_offset": -1,
        "records": [{
            "id": "045c1de6-327b-11e4-818b-5404a67f3363",
            "name": "Financial",
            "date_entered": null,
            "date_modified": null,
            "modified_user_id": null,
            "created_by": null,
            "description": null,
            "deleted": "0",
            "source_id": null,
            "source_type": null,
            "source_meta": null,
            "root": "935d3e07-327a-11e4-818b-5404a67f3363",
            "lft": "11",
            "rgt": "14",
            "level": "2",
            "children": {
                "next_offset": -1,
                "records": [{
                    "id": "0f658847-327b-11e4-818b-5404a67f3363",
                    "name": "Invoices",
                    "date_entered": null,
                    "date_modified": null,
                    "modified_user_id": null,
                    "created_by": null,
                    "description": null,
                    "deleted": "0",
                    "source_id": null,
                    "source_type": null,
                    "source_meta": null,
                    "root": "935d3e07-327a-11e4-818b-5404a67f3363",
                    "lft": "12",
                    "rgt": "13",
                    "level": "3",
                    "children": {
                        "next_offset": -1,
                        "records": []
                    }
                }]
            }
        }, {
            "id": "0f65a6c7-327b-11e4-818b-5404a67f3363",
            "name": "Agreements",
            "date_entered": null,
            "date_modified": null,
            "modified_user_id": null,
            "created_by": null,
            "description": null,
            "deleted": "0",
            "source_id": null,
            "source_type": null,
            "source_meta": null,
            "root": "935d3e07-327a-11e4-818b-5404a67f3363",
            "lft": "15",
            "rgt": "16",
            "level": "2",
            "children": {
                "next_offset": -1,
                "records": []
            }
        }, {
            "id": "14d30bf3-327b-11e4-818b-5404a67f3363",
            "name": "Clients",
            "date_entered": null,
            "date_modified": null,
            "modified_user_id": null,
            "created_by": null,
            "description": null,
            "deleted": "0",
            "source_id": null,
            "source_type": null,
            "source_meta": null,
            "root": "935d3e07-327a-11e4-818b-5404a67f3363",
            "lft": "17",
            "rgt": "18",
            "level": "2",
            "children": {
                "next_offset": -1,
                "records": []
            }
        }]
    }
}]
}

Change Log

Version Change
v10 Added /<module>/:record/tree GET endpoint.