Documentation ¶
Index ¶
- Constants
- func GetEndpoint(objType, action string) (string, error)
- type BackOffClient
- type ChangeOwnerData
- type Client
- func (c *Client) ChangeOwner(objType, objAPIName string, data []*ChangeOwnerData) error
- func (c *Client) CreateObj(objType string, obj interface{}, params map[string]interface{}) (string, error)
- func (c *Client) DeleteObjs(objType, objAPIName string, idList []string) error
- func (c *Client) DescribeObj(objAPIName string, includeDetail bool) (string, error)
- func (c *Client) GetObjByID(objType, objApiName, id string) (obj []byte, err error)
- func (c *Client) GetUserByOpenID(openUserID string) (user *User, err error)
- func (c *Client) InvalidObj(objType, objAPIName, id string) error
- func (c *Client) ListAllObjs(objType, objApiName string, searchQueryInfo *SearchQueryInfo) (allObjs []json.RawMessage, err error)
- func (c *Client) ListObjs(objType, objApiName string, searchQueryInfo *SearchQueryInfo, ...) (objs []json.RawMessage, total int, err error)
- func (c *Client) ListUsersByDepartmentID(departmentID int, fetchChild bool) (users []*User, err error)
- func (c *Client) Post(endpoint string, data map[string]interface{}, auth bool) (content string, err error)
- func (c *Client) RawPost(endpoint string, data map[string]interface{}, auth bool) (*http.Response, error)
- func (c *Client) RefreshAccessToken() error
- func (c *Client) UpdateObj(objType string, obj map[string]interface{}, params map[string]interface{}) error
- type Object
- type QueryFilter
- type QueryOrder
- type QueryResult
- type SearchQueryInfo
- type User
Constants ¶
View Source
const ( BaseURL = "https://open.fxiaoke.com" EndpointGetToken = "/cgi/corpAccessToken/get/V2" )
View Source
const ( ObjTypePackage = "package" // 预设对象 ObjTypeCustom = "custom" // 自定义对象 FieldAPINameName = "name" FieldAPINameOwner = "owner" FieldAPINameCreateTime = "create_time" FieldAPINameCreatedBy = "created_by" FieldAPINameLastModifiedTime = "last_modified_time" FieldAPINameLastModifiedBy = "last_modified_by" FieldAPINameRecordType = "record_type" // 业务类型 FieldAPINameLifeStatus = "life_status" // 生命状态 FilterOperatorEQ = "EQ" FilterOperatorLT = "LT" FilterOperatorLTE = "LTE" FilterOperatorLike = "LIKE" FilterOperatorIs = "IS" FilterOperatorIn = "IN" FilterOperatorBetween = "BETWEEN" FilterOperatorStartWith = "STARTWITH" FilterOperatorContains = "CONTAINS" FilterOperatorGT = "GT" FilterOperatorGTE = "GTE" FilterOperatorNotEqual = "N" // Not equal FilterOperatorNotLike = "NLIKE" FilterOperatorIsNot = "ISN" FilterOperatorNotIn = "NIN" FilterOperatorNotBetween = "NBETWEEN" FilterOperatorEndWith = "ENDWITH" ActionQuery = "query" ActionGet = "get" ActionInvalid = "invalid" ActionChangeOwner = "changeOwner" ActionUpdate = "update" ActionCreate = "create" ActionDelete = "delete" ParamTriggerWorkFlow = "triggerWorkFlow" // 触发工作流 ParamTriggerApprovalFlow = "triggerApprovalFlow" // 触发审批流 )
Variables ¶
This section is empty.
Functions ¶
func GetEndpoint ¶ added in v0.0.7
Types ¶
type BackOffClient ¶
type BackOffClient struct {
// contains filtered or unexported fields
}
type ChangeOwnerData ¶
type Client ¶
type Client struct {
// contains filtered or unexported fields
}
func (*Client) ChangeOwner ¶
func (c *Client) ChangeOwner(objType, objAPIName string, data []*ChangeOwnerData) error
func (*Client) DeleteObjs ¶
只能删除已作废的对象 该方法不支持 客户对象 中的 删除公海对象接口:https://open.fxiaoke.com/wiki.html#artiId=1258
func (*Client) DescribeObj ¶
func (*Client) GetObjByID ¶
func (*Client) GetUserByOpenID ¶
func (*Client) ListAllObjs ¶
func (c *Client) ListAllObjs(objType, objApiName string, searchQueryInfo *SearchQueryInfo) (allObjs []json.RawMessage, err error)
func (*Client) ListObjs ¶
func (c *Client) ListObjs(objType, objApiName string, searchQueryInfo *SearchQueryInfo, params map[string]interface{}) (objs []json.RawMessage, total int, err error)
func (*Client) ListUsersByDepartmentID ¶
func (*Client) RefreshAccessToken ¶
type QueryFilter ¶
type QueryOrder ¶
type QueryResult ¶
type QueryResult struct { Total int `json:"total"` Offset int `json:"offset"` Limit int `json:"limit"` DataList []json.RawMessage `json:"dataList"` }
type SearchQueryInfo ¶
type SearchQueryInfo struct { Limit int `json:"limit"` Offset int `json:"offset"` Filters []*QueryFilter `json:"filters"` FieldProjection []string `json:"fieldProjection"` Orders []*QueryOrder `json:"orders"` }
type User ¶
type User struct { OpenUserID string `json:"openUserId"` Name string `json:"name"` NickName string `json:"nickName"` LeaderID string `json:"leaderId"` Position string `json:"position"` Email string `json:"email"` DepartmentIDs []int `json:"departmentIds"` Mobile string `json:"mobile"` CreateTime int64 `json:"createTime"` }
Click to show internal directories.
Click to hide internal directories.