修改日历
功能介绍
修改日历
URI
PUT /v1/iotfm/calendars/{calendar_id}
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
calendar_id |
是 |
String |
日历ID。 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
参数说明:用户Token。通过调用 生成Token 接口获取,接口返回的响应消息头中“X-Subject-Token”就是需要获取的用户Token。 |
X-Instance-Id |
是 |
String |
参数说明:实例ID。通过访问智能设施云平台界面后获取,智能设施云平台资源均为实例级隔离,所有业务接口必须填写正确的实例ID才能被成功调用。 取值范围:长度8-36,只允许大小写字母、数字和-字符的组合。 |
X-Root-Zone-Id |
否 |
String |
参数说明:项目ID。 取值范围:长度不超过24,只允许字母、数字的组合。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
name |
否 |
String |
日历名称。长度不超过64,只允许中文、字母、数字、以及_-等字符的组合。 |
description |
否 |
String |
日历描述。长度不超过500,只允许中文、字母、数字、以及_-,,!!。.等字符的组合。 |
mgmt_zone_id |
否 |
String |
参数说明:管理空间ID。 注意事项:该参数已废弃。 |
custom_calendars |
否 |
Array of CustomCalendar objects |
自定义日历 |
holiday_calendars |
否 |
Array of CustomCalendar objects |
节假日日历 |
week_calendars |
否 |
Array of WeekCalendar objects |
周循环日历 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
date_items_name |
否 |
String |
日期项名称。长度不超过64,只允许中文、字母、数字、以及_-等字符的组合。 |
date_items |
是 |
Array of DateItem objects |
日历项 |
响应参数
状态码:200
参数 |
参数类型 |
描述 |
---|---|---|
calendar_id |
String |
日历ID,创建日历时由设施云平台分配获得。 |
name |
String |
日历名称。长度不超过64,只允许中文、字母、数字、以及_-等字符的组合。 |
description |
String |
日历描述。长度不超过500,只允许中文、字母、数字、以及_-,,!!。.等字符的组合。 |
mgmt_zone_id |
String |
参数说明:管理空间ID。 注意事项:该参数已废弃。 |
mgmt_zone_name |
String |
参数说明:管理空间名称。 注意事项:该参数已废弃。 |
custom_calendars |
Array of CustomCalendar objects |
自定义日历 |
holiday_calendars |
Array of CustomCalendar objects |
节假日日历 |
week_calendars |
Array of WeekCalendar objects |
周循环日历 |
create_time |
String |
日历创建时间,格式:yyyy-MM-dd'T'HH:mm:ss.SSS'Z' |
update_time |
String |
日历更新时间,格式:yyyy-MM-dd'T'HH:mm:ss.SSS'Z' |
参数 |
参数类型 |
描述 |
---|---|---|
date_items_name |
String |
日期项名称。长度不超过64,只允许中文、字母、数字、以及_-等字符的组合。 |
date_items |
Array of DateItem objects |
日历项 |
状态码:400
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
参数说明:错误码。 取值范围:长度8-36。 |
error_msg |
String |
参数说明:错误描述。 取值范围:长度2-512。 |
请求示例
无
响应示例
无
状态码
状态码 |
描述 |
---|---|
200 |
修改日历成功 |
400 |
Error response |