远焦模板接口

关联数据库文档

模板信息表

详细接口文档

获取模板

/template/${template_name}

通过模板名称获取指定模板的信息。

Request parameters

Responses

            {
                "error_code": 0,
                "error_message": "success",
                "data": {
                    "template_id": 114514,
                    "name": "example_template",
                    "content": "${project} now is ${status} at ${hour}:${min}",
                    "arguments": {
                        "project": "project_name",
                        "status": "offline",
                        "hour": 12,
                        "min": 30
                    },
                    "preview": "project_name now is offline at 12:30"
                }
            }
        

            {
                "error_code": 4011,
                "error_message": "invalid authorization token"
            }
        

            {
                "error_code": 4041,
                "error_message": "template not exist"
            }
        

新建模板

/template

创建一个新的模板。

Request parameters

                {
                    "name": "example_template",
                    "content": "${project} now is ${status} at ${hour}:${min}",
                    "arguments": {
                        "project": "project_name",
                        "status": "offline",
                        "hour": 12,
                        "min": 30
                    }
                }
            

Responses

            {
                "name": "example_template",
                "content": "${project} now is ${status} at ${hour}:${min}",
                "arguments": {
                    "project": "project_name",
                    "status": "offline",
                    "hour": 12,
                    "min": 30
                }
            }
        

            {
                "error_code": 4011,
                "error_message": "invalid authorization token"
            }
        

            {
                "error_code": 4091,
                "error_message": "template already exist"
            }
        

更改模板

/template/${template_name}

通过模板名称更改指定模板的信息。

Request parameters

                {
                    "content": "${project} now is ${status} at ${hour}:${min}",
                    "arguments": {
                        "project": "project_name",
                        "status": "offline",
                        "hour": 12,
                        "min": 30
                    }
                }
            

                {
                    "content": "${project} now is ${status} at ${hour}:${min}"
                }
            

Responses

            {
                "error_code": 0,
                "error_message": "success",
                "data": {
                    "template_id": 114514,
                    "name": "example_template",
                    "content": "${project} now is ${status} at ${hour}:${min}",
                    "arguments": {
                        "project": "project_name",
                        "status": "offline",
                        "hour": 12,
                        "min": 30
                    },
                    "preview": "project_name now is offline at 12:30"
                }
            }
        

            {
                "error_code": 4011,
                "error_message": "invalid authorization token"
            }
        

            {
                "error_code": 4041,
                "error_message": "template not exist"
            }
        

删除模板

/template/${template_name}

通过模板名称删除指定模板。

Request parameters

Responses

            {
                "error_code": 0,
                "error_message": "success"
            }
        

            {
                "error_code": 4011,
                "error_message": "invalid authorization token"
            }
        

            {
                "error_code": 4041,
                "error_message": "template not exist"
            }
        

预览模板

/template/${template_name}/preview

通过模板名称和传入的变量预览模板的内容。

Request parameters

                {
                    "project": "project_name",
                    "status": "offline",
                    "hour": 12,
                    "min": 30
                }
            

null

Responses

            {
                "error_code": 0,
                "error_message": "success",
                "data": {
                    "preview": "project_name now is offline at 12:30"
                }
            }
        

            {
                "error_code": 4011,
                "error_message": "invalid authorization token"
            }
        

            {
                "error_code": 4041,
                "error_message": "template not exist"
            }
        

Last modified: 28 October 2024