-
-
Notifications
You must be signed in to change notification settings - Fork 71
/
Copy pathapi_corehr_custom_field_get.go
179 lines (155 loc) · 11.9 KB
/
api_corehr_custom_field_get.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
// Code generated by lark_sdk_gen. DO NOT EDIT.
/**
* Copyright 2022 chyroc
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package lark
import (
"context"
)
// GetCoreHRCustomField 获取「飞书人事」对象下某字段的详细信息, 支持系统预置字段和自定义字段。通常可通过该接口获取某个对象中字段的枚举值列表。使用方式可参考[操作手册]如何通过 OpenAPI 维护自定义字段](https://feishu.feishu.cn/docx/QlUudBfCtosWMbxx3vxcOFDknn7)
//
// doc: https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/custom_field/get_by_param
// new doc: https://open.feishu.cn/document/server-docs/corehr-v1/basic-infomation/custom_field/get_by_param
func (r *CoreHRService) GetCoreHRCustomField(ctx context.Context, request *GetCoreHRCustomFieldReq, options ...MethodOptionFunc) (*GetCoreHRCustomFieldResp, *Response, error) {
if r.cli.mock.mockCoreHRGetCoreHRCustomField != nil {
r.cli.Log(ctx, LogLevelDebug, "[lark] CoreHR#GetCoreHRCustomField mock enable")
return r.cli.mock.mockCoreHRGetCoreHRCustomField(ctx, request, options...)
}
req := &RawRequestReq{
Scope: "CoreHR",
API: "GetCoreHRCustomField",
Method: "GET",
URL: r.cli.openBaseURL + "/open-apis/corehr/v1/custom_fields/get_by_param",
Body: request,
MethodOption: newMethodOption(options),
NeedTenantAccessToken: true,
}
resp := new(getCoreHRCustomFieldResp)
response, err := r.cli.RawRequest(ctx, req, resp)
return resp.Data, response, err
}
// MockCoreHRGetCoreHRCustomField mock CoreHRGetCoreHRCustomField method
func (r *Mock) MockCoreHRGetCoreHRCustomField(f func(ctx context.Context, request *GetCoreHRCustomFieldReq, options ...MethodOptionFunc) (*GetCoreHRCustomFieldResp, *Response, error)) {
r.mockCoreHRGetCoreHRCustomField = f
}
// UnMockCoreHRGetCoreHRCustomField un-mock CoreHRGetCoreHRCustomField method
func (r *Mock) UnMockCoreHRGetCoreHRCustomField() {
r.mockCoreHRGetCoreHRCustomField = nil
}
// GetCoreHRCustomFieldReq ...
type GetCoreHRCustomFieldReq struct {
CustomApiName string `query:"custom_api_name" json:"-"` // 字段 apiname, 示例值: custom_field_33
ObjectApiName string `query:"object_api_name" json:"-"` // 所属对象 apiname, 示例值: offboarding_info
}
// GetCoreHRCustomFieldResp ...
type GetCoreHRCustomFieldResp struct {
Data *GetCoreHRCustomFieldRespData `json:"data,omitempty"` // 字段详情
}
// GetCoreHRCustomFieldRespData ...
type GetCoreHRCustomFieldRespData struct {
CustomApiName string `json:"custom_api_name,omitempty"` // 字段 apiname, 即字段的唯一标识
Name *GetCoreHRCustomFieldRespDataName `json:"name,omitempty"` // 字段名称
Description *GetCoreHRCustomFieldRespDataDescription `json:"description,omitempty"` // 描述
IsOpen bool `json:"is_open,omitempty"` // 是否启用
IsRequired bool `json:"is_required,omitempty"` // 是否必填
IsUnique bool `json:"is_unique,omitempty"` // 是否唯一
ObjectApiName string `json:"object_api_name,omitempty"` // 所属对象 apiname
Type int64 `json:"type,omitempty"` // 字段类型, 可选值有: 1: 文本 Text, “文本”和“超链接”属于该类型, 2: 布尔 Boolean, 3: 数字 Number, 4: 枚举 Option, “单选”和“多选”为该类型, 5: 查找 Lookup, “人员（单选）”、“人员（多选）”和个人信息中的自定义分组为该类型, 6: 自动编码 Autonumber, 7: 日期时间 Datetime, 8: 附件 Attachment, “附件单选”和“附件多选”为该类型, 9: 图片 Image, 10: 计算字段 Calculated, 11: 反向查找 Backlookup
CommonSchemaConfig *GetCoreHRCustomFieldRespDataCommonSchemaConfig `json:"common_schema_config,omitempty"` // 配置信息, 当前仅字段类型为「文本」、「布尔」、「数字」、「枚举」、「日期时间」、「附件」、「图片」时返回具体的配置信息, 其余类型的自定义字段暂不返回
CreateTime string `json:"create_time,omitempty"` // 创建时间, 秒级时间戳
UpdateTime string `json:"update_time,omitempty"` // 更新时间, 秒级时间戳
}
// GetCoreHRCustomFieldRespDataCommonSchemaConfig ...
type GetCoreHRCustomFieldRespDataCommonSchemaConfig struct {
TextFieldSetting *GetCoreHRCustomFieldRespDataCommonSchemaConfigTextFieldSetting `json:"text_field_setting,omitempty"` // 文本配置信息
NumberFieldSetting *GetCoreHRCustomFieldRespDataCommonSchemaConfigNumberFieldSetting `json:"number_field_setting,omitempty"` // 数字配置信息
EnumFieldSetting *GetCoreHRCustomFieldRespDataCommonSchemaConfigEnumFieldSetting `json:"enum_field_setting,omitempty"` // 选项配置信息
LookupFieldSetting *GetCoreHRCustomFieldRespDataCommonSchemaConfigLookupFieldSetting `json:"lookup_field_setting,omitempty"` // 查找字段配置信息
DateTimeFieldSetting *GetCoreHRCustomFieldRespDataCommonSchemaConfigDateTimeFieldSetting `json:"date_time_field_setting,omitempty"` // 日期时间配置信息
AttachmentFieldSetting *GetCoreHRCustomFieldRespDataCommonSchemaConfigAttachmentFieldSetting `json:"attachment_field_setting,omitempty"` // 附件配置信息
ImageFieldSetting *GetCoreHRCustomFieldRespDataCommonSchemaConfigImageFieldSetting `json:"image_field_setting,omitempty"` // 图片配置信息
}
// GetCoreHRCustomFieldRespDataCommonSchemaConfigAttachmentFieldSetting ...
type GetCoreHRCustomFieldRespDataCommonSchemaConfigAttachmentFieldSetting struct {
IsMultiple bool `json:"is_multiple,omitempty"` // 是否支持多个文件
FileType FileType `json:"file_type,omitempty"` // 文件类型枚举, 可选值有: `1`: jpeg, `2`: png, `3`: gif, `4`: pdf, `5`: docx, `6`: doc, `7`: csv, `8`: xls, `9`: txt, `10`: xlsx, `11`: mp4, `12`: pptx, `13`: ppt, `14`: json, `15`: zip, `16`: rar
}
// GetCoreHRCustomFieldRespDataCommonSchemaConfigDateTimeFieldSetting ...
type GetCoreHRCustomFieldRespDataCommonSchemaConfigDateTimeFieldSetting struct {
DateTimeType int64 `json:"date_time_type,omitempty"` // 时间类型枚举, 可选值有: `1`: Date 日期, 如 2020-01-01, `2`: Time 时间, 如 11:52:00, `3`: Datetime 日期时间, 如 2020-01-01 11:52:00, `4`: CusDatetime // timestamp 时间戳
}
// GetCoreHRCustomFieldRespDataCommonSchemaConfigEnumFieldSetting ...
type GetCoreHRCustomFieldRespDataCommonSchemaConfigEnumFieldSetting struct {
EnumFieldOptionList []*GetCoreHRCustomFieldRespDataCommonSchemaConfigEnumFieldSettingEnumFieldOption `json:"enum_field_option_list,omitempty"` // 选项信息
IsMultiple bool `json:"is_multiple,omitempty"` // 是否为多选
}
// GetCoreHRCustomFieldRespDataCommonSchemaConfigEnumFieldSettingEnumFieldOption ...
type GetCoreHRCustomFieldRespDataCommonSchemaConfigEnumFieldSettingEnumFieldOption struct {
ApiName string `json:"api_name,omitempty"` // 选项 api_name, 即选项的唯一标识
Name *GetCoreHRCustomFieldRespDataCommonSchemaConfigEnumFieldSettingEnumFieldOptionName `json:"name,omitempty"` // 选项名称
Description *GetCoreHRCustomFieldRespDataCommonSchemaConfigEnumFieldSettingEnumFieldOptionDescription `json:"description,omitempty"` // 选项描述
IsOpen bool `json:"is_open,omitempty"` // 是否启用
}
// GetCoreHRCustomFieldRespDataCommonSchemaConfigEnumFieldSettingEnumFieldOptionDescription ...
type GetCoreHRCustomFieldRespDataCommonSchemaConfigEnumFieldSettingEnumFieldOptionDescription struct {
ZhCn string `json:"zh_cn,omitempty"` // 中文
EnUs string `json:"en_us,omitempty"` // 英文
}
// GetCoreHRCustomFieldRespDataCommonSchemaConfigEnumFieldSettingEnumFieldOptionName ...
type GetCoreHRCustomFieldRespDataCommonSchemaConfigEnumFieldSettingEnumFieldOptionName struct {
ZhCn string `json:"zh_cn,omitempty"` // 中文
EnUs string `json:"en_us,omitempty"` // 英文
}
// GetCoreHRCustomFieldRespDataCommonSchemaConfigImageFieldSetting ...
type GetCoreHRCustomFieldRespDataCommonSchemaConfigImageFieldSetting struct {
ImageType int64 `json:"image_type,omitempty"` // 图片类型枚举, 可选值有: `1`: Avatar 头像, `2`: BadgePhoto 工卡照片, `3`: Logo 标志
DisplayStyle int64 `json:"display_style,omitempty"` // 显示样式枚举, 可选值有: `1`: SquareImage 方形, `2`: RoundImage 圆形
}
// GetCoreHRCustomFieldRespDataCommonSchemaConfigLookupFieldSetting ...
type GetCoreHRCustomFieldRespDataCommonSchemaConfigLookupFieldSetting struct {
LookupObjApiName string `json:"lookup_obj_api_name,omitempty"` // 查找字段对应的对象 apiname, 可通过[获取自定义字段列表](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/custom_field/query)接口获取这个对象中定义的自定义字段
IsMultiple bool `json:"is_multiple,omitempty"` // 是否为多值
}
// GetCoreHRCustomFieldRespDataCommonSchemaConfigNumberFieldSetting ...
type GetCoreHRCustomFieldRespDataCommonSchemaConfigNumberFieldSetting struct {
NumberFieldType int64 `json:"number_field_type,omitempty"` // 数字类型, 可选值有: `1`: Percent 百分比, `2`: Integer 整数, `3`: Value 数值（浮点数）, `4`: Money 金额（浮点数）
DecimalPlaces int64 `json:"decimal_places,omitempty"` // 小数部分位数（浮点数整数部分和小数部分分别最大30位）
RoundType int64 `json:"round_type,omitempty"` // 四舍五入规则, 可选值有: `0`: Round 四舍五入, `1`: Ceil 向上舍入, `2`: Floor 向下舍入
DecimalTotalPlaces int64 `json:"decimal_total_places,omitempty"` // 整数+小数总位数
}
// GetCoreHRCustomFieldRespDataCommonSchemaConfigTextFieldSetting ...
type GetCoreHRCustomFieldRespDataCommonSchemaConfigTextFieldSetting struct {
IsMultilingual bool `json:"is_multilingual,omitempty"` // 是否多语言
IsMultiline bool `json:"is_multiline,omitempty"` // 是否多行
MaxLength int64 `json:"max_length,omitempty"` // 最大长度
IsURLType bool `json:"is_url_type,omitempty"` // 是否是URL类型
}
// GetCoreHRCustomFieldRespDataDescription ...
type GetCoreHRCustomFieldRespDataDescription struct {
ZhCn string `json:"zh_cn,omitempty"` // 中文
EnUs string `json:"en_us,omitempty"` // 英文
}
// GetCoreHRCustomFieldRespDataName ...
type GetCoreHRCustomFieldRespDataName struct {
ZhCn string `json:"zh_cn,omitempty"` // 中文
EnUs string `json:"en_us,omitempty"` // 英文
}
// getCoreHRCustomFieldResp ...
type getCoreHRCustomFieldResp struct {
Code int64 `json:"code,omitempty"` // 错误码, 非 0 表示失败
Msg string `json:"msg,omitempty"` // 错误描述
Data *GetCoreHRCustomFieldResp `json:"data,omitempty"`
Error *ErrorDetail `json:"error,omitempty"`
}