Query Scene Template List

Last Updated on : 2023-06-15 05:07:45

Query the list of scene templates. Support fuzzy matching by name and display results on pages.

API address

GET: /v1.0/iot-03/scene-templates

Request parameter

Parameter name	Type	IN	Required	Description
req	SceneTemplateListReq	query	false	The input parameters.

Description of req

Parameter name	Type	Required	Description
page_no	Integer	false	The page number.
page_size	Integer	false	The number of items returned on each page.
name	String	false	The name of a specified template.

Return parameter

Parameter name	Type	Description
result	PageResult	The returned results on pages.

Description of result

Parameter name	Type	Description
total	Long	The total number of results.
has_more	Boolean	Specifies whether to return the next page.
data	List	The items on pages.

Description of data

Parameter name	Type	Description
template_id	Long	The ID of a specified template.
name	String	The name of a specified template.
desc	String	The description of a specified template.
create_time	Long	The time when a template is created.
modify_time	Long	The time when a template is modified.

Request example

GET: /v1.0/iot-03/scene-templates?page_no=1&page_size=10

Return example

{
    "result": {
        "data": [
            {
                "create_time": 1635592433938,
                "modify_time": 1635592433938,
                "name": "Linkage Template",
                "template_id": "18***8",
                "desc": "The second template"
            },
            {
                "create_time": 1636027476128,
                "modify_time": 1636031697242,
                "name": "Linkage Weather Timer Template",
                "template_id": "18***1",
                "desc": "The first weather timer template"
            },
            {
                "create_time": 1636098604034,
                "modify_time": 1636098604034,
                "name": "Linkage Weather Timer Template-Format Verification",
                "template_id": "18***5",
                "desc": "The first weather timer template"
            },
            {
                "create_time": 1636098719046,
                "modify_time": 1636098719046,
                "name": "Weather Template",
                "template_id": "1***06",
                "desc": "The first weather timer template"
            },
            {
                "create_time": 1636455582091,
                "modify_time": 1636545567830,
                "name": "Update Template",
                "template_id": "18***1",
                "desc": "The first weather timer template"
            },
            {
                "create_time": 1636546481391,
                "modify_time": 1636546481391,
                "name": "Test 1",
                "template_id": "19***7",
                "desc": "The first weather timer template"
            }
        ],
        "total": 6,
        "has_more": false
    },
    "t": 1636612636741,
    "success": true
}

Error code

For more information, see error code.

Prev DocQuery Scene Template Application List

Next DocAdd Scene Template