Cloud Services API ReferenceSmart HomeSmart Home Content ManageCategory ManagementQuery Category Information

Query Category Information

Last Updated on : 2023-06-20 12:34:15download

Query the information about categories on pages, according to the language, status, and other parameters.

API address

GET: /v1.0/iot-03/app-contents/categories

Request parameter

Parameter name	Type	IN	Required	Description
lang	String	query	false	The language.
status	Integer	query	false	The status of the category. Valid values: `1`: unreleased. `2`: released. `3`: removed.
page_size	Integer	query	true	The number of items per page.
page_no	Integer	query	true	The page number.
schema	String	query	false	App schema

Return parameter

Parameter name	Type	Description
result	PageResult	The list of categories on pages.

Description of result

Parameter name	Type	Description
page_info	PageInfo	The information on a page.
datas	List	The list of categories.

Description of datas

Parameter name	Type	Description
category_id	String	The ID of a specified category.
category_name	String	The name of a specified category.
status	Integer	The status of the category. Valid values: `1`: unreleased. `2`: released. `3`: removed.
lang_info	List	The multilingual information about the categories.
remark	String	The description of the categories.
creator	String	The person who has created the category.
modifier	String	The person who has modified the category.
tenant_id	String	The ID of a specified tenant.
schema	String	App schema
create_time	Long	The time when it is created.
update_time	Long	The time when it is updated.

Description of page_info

Parameter name	Type	Description
page_count	Integer	The total number of pages.
page_size	Integer	The number of items to be returned per page.
total	Integer	The total number.
page_no	Integer	The number of the current page.

Description of lang_info

Parameter name	Type	Description
lang	String	The language.
value	String	The multilingual value.

Request example

GET: /v1.0/iot-03/app-contents/categories?page_no=1&page_size=10&lang=zh&scheme=13&status=1

Return example

{
    "result": {
        "datas": [
            {
                "schema": 12,
                "gmt_create": 1630315231888,
                "tenant_id": "bsh1618231457224vDlX",
                "creator": "bsh1618231457224vDlX",
                "category_name": "Test",
                "modifier": "bsh1618231457224vDlX",
                "remark": "Test",
                "gmt_modified": 1630315540751,
                "lang_info": [
                    {
                        "lang": "en",
                        "value": "QIANLONG_en_PyF"
                    },
                    {
                        "lang": "fr",
                        "value": "QIANLONG_fr_PyF"
                    },
                    {
                        "lang": "zh",
                        "value": "Test_PyF"
                    }
                ],
                "category_id": "1432272008825016349",
                "status": 1
            }
        ],
        "page_info": {
            "page_no": 1,
            "total": 1,
            "page_count": 1,
            "page_size": 10
        }
    },
    "t": 1630326280943,
    "success": true
}

Error code

For more information, see error code.

Prev DocCategory Statistics

Next DocContent Management