目录

创建/更新运动记录

功能介绍

创建或修改一个运动记录,并支持将锻炼时长和热量写入三环中。

场景描述

创建或修改一个运动记录。如跑步、跳绳等运动记录。

使用约束

开发者调用该接口可写入下表中的统计数据类型数据。

统计数据类型

统计类型名称

原子数据类型

步数

com.huawei.continuous.steps.total

com.huawei.continuous.steps.delta

距离

com.huawei.continuous.distance.total

com.huawei.continuous.distance.delta

卡路里

com.huawei.continuous.calories.burnt.total

com.huawei.continuous.calories.burnt

运动心率

com.huawei.continuous.exercise_heart_rate.statistics

com.huawei.instantaneous.exercise_heart_rate

步频

com.huawei.continuous.steps.rate.statistics

com.huawei.instantaneous.steps.rate

跳跃

com.huawei.continuous.jump.statistics

com.huawei.continuous.jump

速度

com.huawei.continuous.speed.statistics

com.huawei.continuous.speed

静息热量

com.huawei.resting_calories.statistics

-

接口原型

承载协议

HTTPS PUT

接口方向

开发者应用->Health Service Kit云

接口URL

https://health-api.cloud.huawei.com/healthkit/v2/activityRecords/{activityRecordId}

数据格式

请求消息:Content-Type: application/json

响应消息:Content-Type: application/json

路径参数

参数

参数类型

是否必选

描述

activityRecordId

String

是

运动记录ID。需与请求体id保持一致,长度范围:1~1000。

请求参数

Request Header

参数

参数类型

是否必选

描述

Content-type

String

是

取值为:application/json; charset=UTF-8

Authorization

String

是

请参见认证鉴权。

说明:

Bearer后面拼接空格,再拼接获取的access_token。

x-client-id

String

否

开放联盟分配的应用标识。服务端可以基于其进行灰度路由,建议携带。

x-version

String

否

接口调用方的软件版本号。即当前客户端版本号,服务端可以基于其进行灰度,建议携带。

x-caller-trace-id

String

否

请求跟踪ID。用于串联服务调用方与服务端整体请求链条,建议携带。

Request Body

参数

参数类型

是否必选

描述

appInfo

AppInfo

是

数据采集器的应用程序信息。请参见AppInfo数据模型。

id

String

否

客户端生成的标识符,在该用户拥有的所有运动记录中都是唯一的。

需与路径参数activityRecordId保持一致,长度范围:1~1000。

startTime

Long

是

运动记录开始时间。单位:毫秒

13位整数的时间戳,对应时间范围是2000-01-01 00:00:00 ~ 2099-12-31 23:59:59。

startTime必须小于endTime。

startTime与endTime相隔时间不能超过5天。

endTime

Long

是

运动记录结束时间。单位:毫秒

13位整数的时间戳,对应时间范围是2000-01-01 00:00:00 ~ 2099-12-31 23:59:59。

endTime必须大于startTime。

startTime与endTime相隔时间不能超过5天。

timeZone

String

是

时区信息。格式:+0800

activityType

Integer

是

运动记录对应的运动类型常量的取值。例如:running对应56。

deviceInfo

DeviceInfo

否

集成各种传感器的硬件设备描述。例如:手表、手环等可穿戴设备。

请参见DeviceInfo数据模型。

activeTime

Long

否

运动记录活跃时间。单位:毫秒。支持计入三环。

activitySummary

ActivitySummary

是

运动记录的概要汇总信息。请参见ActivitySummary数据模型。

desc

String

否

运动记录描述。长度范围:1~1000。

subDataRelation

List<SamplePointRelation>

否

子数据关联关系。

details

List<SampleSet>

否

运动记录明细数据。请参见SampleSet数据模型。

modifyTime

Long

否

运动记录的最后修改时间。

若用户创建activityRecords时填写了modifyTime,界面返回用户创建的activityRecords信息时将返回传入的modifyTime值;否则不返回。

name

String

否

用户设定的运动记录名称。长度范围:1~1000。

请求示例

PUT
https://health-api.cloud.huawei.com/healthkit/v2/activityRecords/sportHealth1775787812164
Content-Type: application/json
Authorization: Bearer ***
x-client-id: ***
x-version: ***
x-caller-trace-id: **
{
    "activityType": 56,
    "appInfo": {
        "appName": "app9",
        "appVersion": "1",
        "desc": "1"
    },
    "endTime": 1775786400000,
    "name": "sportHealth1775787812164",
    "id": "sportHealth1775787812164",
    "desc": "sportHealth1775787812164",
    "modifyTime": 1775786400000,
    "startTime": 1775784600000,
    "activeTime": 610000,
    "activitySummary": {
        "paceSummary": {
            "paceMap": {
                "1.0": 478.0,
                "1.21": 628.0
            },
            "sportHealthPaceMap": {
                "5600000": 746.0
            },
            "partTimeMap": {
                "1.0": 478.0
            },
            "avgPace": 746.42857,
            "bestPace": 0.0
        },
        "performanceSummary": {
            "aerobicTrainingStress": 1.2,
            "anaerobicTrainingStress": 1.3,
            "recoveryTime": 10,
            "vo2Max": 35
        },
        "dataSummary": [
            {
                "startTime": 1724997600000000000,
                "endTime": 1724999490000000000,
                "dataTypeName": "com.huawei.continuous.calories.burnt.total",
                "value": [
                    {
                        "fieldName": "calories_total",
                        "floatValue": 31.0
                    }
                ]
            },
            {
                "startTime": 1724997600000000000,
                "endTime": 1724999490000000000,
                "dataTypeName": "com.huawei.continuous.steps.total",
                "value": [
                    {
                        "fieldName": "steps",
                        "integerValue": 701
                    },
                    {
                        "fieldName": "duration",
                        "integerValue": 6
                    }
                ]
            },
            {
                "startTime": 1724997600000000000,
                "endTime": 1724999490000000000,
                "dataTypeName": "com.huawei.continuous.distance.total",
                "value": [
                    {
                        "fieldName": "distance",
                        "floatValue": 560.0
                    }
                ]
            },
            {
                "startTime": 1724997600000000000,
                "endTime": 1724999490000000000,
                "dataTypeName": "com.huawei.continuous.exercise_heart_rate.statistics",
                "value": [
                    {
                        "fieldName": "avg",
                        "floatValue": 100.0
                    },
                    {
                        "fieldName": "max",
                        "floatValue": 111.0
                    },
                    {
                        "fieldName": "min",
                        "floatValue": 78.0
                    }
                ]
            },
            {
                "startTime": 1724997600000000000,
                "endTime": 1724999490000000000,
                "dataTypeName": "com.huawei.continuous.steps.rate.statistics",
                "value": [
                    {
                        "fieldName": "avg",
                        "floatValue": 100.0
                    },
                    {
                        "fieldName": "max",
                        "floatValue": 132.0
                    },
                    {
                        "fieldName": "min",
                        "floatValue": 0.0
                    }
                ]
            },
            {
                "startTime": 1724997600000000000,
                "endTime": 1724999490000000000,
                "dataTypeName": "com.huawei.continuous.speed.statistics",
                "value": [
                    {
                        "fieldName": "avg",
                        "floatValue": 1.34
                    },
                    {
                        "fieldName": "max",
                        "floatValue": 1.34
                    }
                ]
            }
        ]
    },
    "timeZone": "+0800"
}

响应参数

状态码为200时:

Response Header

参数类型

参数类型

是否必选

描述

Content-Type

String

是

取值为:application/json; charset=UTF-8

Response Body

参数

参数类型

是否必选

描述

id

String

是

客户端生成的标识符,在该用户拥有的所有运动记录中都是唯一的。

需与路径参数activityRecordId保持一致,长度范围:1~1000。

startTime

Long

是

运动记录开始时间。单位:毫秒

13位整数的时间戳,对应时间范围是2000-01-01 00:00:00 ~ 2099-12-31 23:59:59。

startTime必须小于endTime。

startTime与endTime相隔时间不能超过5天。

endTime

Long

是

运动记录结束时间。单位:毫秒

13位整数的时间戳,对应时间范围是2000-01-01 00:00:00 ~ 2099-12-31 23:59:59。

endTime必须大于startTime。

startTime与endTime相隔时间不能超过5天。

timeZone

String

是

时区信息。格式:+0800

appInfo

AppInfo

是

数据采集器的应用程序信息。请参见AppInfo数据模型。

activityType

Integer

否

运动记录对应的运动类型常量的取值。例如:running对应56。

activeTime

Long

否

运动记录活跃时间。单位:毫秒

desc

String

否

运动记录描述。长度范围:1~1000。

activitySummary

ActivitySummary

否

运动记录的概要汇总信息。请参见ActivitySummary数据模型。

details

List<SampleSet>

否

运动记录明细数据。请参见SampleSet数据模型。

deviceInfo

DeviceInfo

否

集成各种传感器的硬件设备描述。例如:手表、手环等可穿戴设备。

请参见DeviceInfo数据模型。

subDataRelation

List<SamplePointRelation>

否

子数据关联关系。

modifyTime

Long

否

运动记录的最后修改时间。

若用户创建activityRecords时填写了modifyTime,界面返回用户创建的activityRecords信息时将返回传入的modifyTime值;否则不返回。

name

String

否

用户设定的运动记录名称。长度范围:1~1000。

响应示例

HTTP/1.1 200 OK
Content-type: application/json;charset=utf-8
{
    "id": "sportHealth1775787812164",
    "name": "sportHealth1775787812164",
    "desc": "sportHealth1775787812164",
    "startTime": 1775784600000,
    "endTime": 1775786400000,
    "modifyTime": 1775786400000,
    "activitySummary": {
        "paceSummary": {
            "paceMap": {
                "1.0": 478.0,
                "1.21": 628.0
            },
            "sportHealthPaceMap": {
                "5600000": 746.0
            },
            "partTimeMap": {
                "1.0": 478.0
            },
            "avgPace": 746.42857,
            "bestPace": 0.0
        },
        "performanceSummary": {
            "aerobicTrainingStress": 1.2,
            "anaerobicTrainingStress": 1.3,
            "recoveryTime": 10,
            "vo2Max": 35
        },
        "dataSummary": [
            {
                "startTime": 1724997600000000000,
                "endTime": 1724999490000000000,
                "dataTypeName": "com.huawei.continuous.calories.burnt.total",
                "value": [
                    {
                        "fieldName": "calories_total",
                        "floatValue": 31.0
                    }
                ]
            },
            {
                "startTime": 1724997600000000000,
                "endTime": 1724999490000000000,
                "dataTypeName": "com.huawei.continuous.steps.total",
                "value": [
                    {
                        "fieldName": "duration",
                        "integerValue": 6
                    },
                    {
                        "fieldName": "steps",
                        "integerValue": 701
                    }
                ]
            },
            {
                "startTime": 1724997600000000000,
                "endTime": 1724999490000000000,
                "dataTypeName": "com.huawei.continuous.distance.total",
                "value": [
                    {
                        "fieldName": "distance",
                        "floatValue": 560.0
                    }
                ]
            },
            {
                "startTime": 1724997600000000000,
                "endTime": 1724999490000000000,
                "dataTypeName": "com.huawei.continuous.exercise_heart_rate.statistics",
                "value": [
                    {
                        "fieldName": "min",
                        "floatValue": 78.0
                    },
                    {
                        "fieldName": "avg",
                        "floatValue": 100.0
                    },
                    {
                        "fieldName": "max",
                        "floatValue": 111.0
                    }
                ]
            },
            {
                "startTime": 1724997600000000000,
                "endTime": 1724999490000000000,
                "dataTypeName": "com.huawei.continuous.steps.rate.statistics",
                "value": [
                    {
                        "fieldName": "min",
                        "floatValue": 0.0
                    },
                    {
                        "fieldName": "avg",
                        "floatValue": 100.0
                    },
                    {
                        "fieldName": "max",
                        "floatValue": 132.0
                    }
                ]
            },
            {
                "startTime": 1724997600000000000,
                "endTime": 1724999490000000000,
                "dataTypeName": "com.huawei.continuous.speed.statistics",
                "value": [
                    {
                        "fieldName": "avg",
                        "floatValue": 1.34
                    },
                    {
                        "fieldName": "max",
                        "floatValue": 1.34
                    }
                ]
            }
        ]
    },
    "timeZone": "+0800",
    "appInfo": {
        "appName": "app9",
        "appVersion": "1",
        "desc": "1",
        "clientId": "104446763"
    },
    "activityType": 56,
    "activeTime": 610000,
    "sourceType": 0,
    "abnormal": 0,
    "duplicate": 0
}

错误码

请参见错误码。