Get Sections

    This API fetches the information about the sections and underlying components—forms, reports, and pages—defined for a ManageEngine AppCreator application's web form factor. Refer to this section to learn about the component type value.

    Request URL

    https://<base_url>/api/v2/<account_owner_name>/<app_link_name>/sections

    Request method

    GET

    Header

    KeyValueDescription
    AuthorizationZoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxfAn authentication token (authtoken) allows users to access apps and APIs without having to enter their login credentials each time.

    OAuth scope

    scope=ZohoCreator.meta.application.READ

    where,

    base_urlthe base URL of your AppCreator account
    For example, the base URL is either  https://host_name:port_number (learn more) or appcreatordemo.manageengine.com (hostname of the server where ManageEngine AppCreator is running).
    account_owner_namethe username of the AppCreator account's owner
    app_link_namethe link name of the target application
    Component Types

    The type value in the response identifies the component type.

    ComponentIts "type" value
    Form1
    Report2
    Page3
    Possible Errors

    Refer to this page for the list of error codes and messages.

    Sample Request

    Copiedcurl "https://appcreatordemo.manageengine.com/api/v2/jason18/zylker-store/sections"
    -X GET
    -H "Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"

    This sample request will fetch the information about the sections, and underlying compnents, defined for the Zylker Store application's web form factor

    Sample Response

    Copied{
      "code": 3000,
      "sections": [
        {
          "components": [
            {
              "page_type": 2,
              "type": 3,
              "link_name": "Dashboard",
              "display_name": "Dashboard"
            }
          ],
          "display_name": "Dashboard",
          "link_name": "Dashboard"
        },
        {
          "components": [
            {
              "view_type": 1,
              "type": 2,
              "link_name": "All_Order_Line_Items",
              "display_name": "All Order Line Items"
            },
            {
              "view_type": 1,
              "type": 2,
              "link_name": "All_Orders",
              "display_name": "All Orders"
            }
          ],
          "display_name": "Orders",
          "link_name": "Orders1"
        },
        {
          "components": [
            {
              "view_type": 1,
              "type": 2,
              "link_name": "All_Products",
              "display_name": "All Products"
            }
          ],
          "display_name": "Inventory",
          "link_name": "Inventory"
        },
        {
          "components": [
            {
              "view_type": 1,
              "type": 2,
              "link_name": "All_Customers",
              "display_name": "All Customers"
            },
            {
              "view_type": 1,
              "type": 2,
              "link_name": "Sales_Reps_Report",
              "display_name": "Sales Reps Report"
            },
            {
              "view_type": 1,
              "type": 2,
              "link_name": "Logistics_Partners_Report",
              "display_name": "Logistics Partners Report"
            }
          ],
          "display_name": "Other Reports",
          "link_name": "Other_Reports"
        }
      ]
    }

    Show full

    Back to Top