Class: K3CloudWebapiSdk::K3CloudApiSdk
- Inherits:
-
Core::WebApiClient
- Object
- Core::WebApiClient
- K3CloudWebapiSdk::K3CloudApiSdk
- Defined in:
- lib/k3cloud_webapi_sdk/main.rb
Overview
Main K3Cloud API SDK class
Instance Attribute Summary collapse
-
#server_url ⇒ Object
Returns the value of attribute server_url.
-
#timeout ⇒ Object
Returns the value of attribute timeout.
Attributes inherited from Core::WebApiClient
#config, #connect_timeout, #cookies_store, #identify, #proxy, #request_timeout
Instance Method Summary collapse
-
#allocate(formid, data) ⇒ Object
Allocate.
-
#attachment_download(data) ⇒ Object
Download attachment.
-
#attachment_upload(data) ⇒ Object
Upload attachment.
-
#audit(formid, data) ⇒ Object
Audit.
-
#batch_save(formid, data) ⇒ Object
Batch save.
-
#batch_save_query(formid, data) ⇒ Object
Batch save with query.
-
#bill_query(data) ⇒ Object
Bill query.
-
#delete(formid, data) ⇒ Object
Delete.
-
#disassembly(formid, data) ⇒ Object
Disassembly.
-
#draft(formid, data) ⇒ Object
Draft.
-
#execute_bill_query(data) ⇒ Object
Execute bill query.
-
#execute_operation(formid, op_number, data) ⇒ Object
Execute operation.
-
#flex_save(formid, data) ⇒ Object
Flex save.
-
#get_data_centers ⇒ Object
Get data centers.
-
#get_sys_report_data(formid, data) ⇒ Object
Get system report data.
-
#group_delete(data) ⇒ Object
Group delete.
-
#group_save(formid, data) ⇒ Object
Group save.
-
#init(config_path = 'conf.ini', config_node = 'config') ⇒ Object
Initialize configuration from file.
-
#init_config(acct_id, user_name, app_id, app_secret, server_url, lcid = 2052, org_num = 0, connect_timeout = 120, request_timeout = 120, proxy = '') ⇒ Object
Initialize configuration with parameters.
-
#initialize(server_url, timeout = 120) ⇒ K3CloudApiSdk
constructor
A new instance of K3CloudApiSdk.
-
#is_valid ⇒ Object
Check if configuration is valid.
-
#push(formid, data) ⇒ Object
Push.
-
#query_business_info(data) ⇒ Object
Query business info.
-
#query_group_info(data) ⇒ Object
Query group info.
-
#save(formid, data) ⇒ Object
Save data.
-
#send_msg(data) ⇒ Object
Send message.
-
#submit(formid, data) ⇒ Object
Submit.
-
#switch_org(data) ⇒ Object
Switch organization.
-
#un_audit(formid, data) ⇒ Object
Undo audit.
-
#view(formid, data) ⇒ Object
View.
-
#workflow_audit(data) ⇒ Object
Workflow audit.
Methods inherited from Core::WebApiClient
#build_header, #execute, #execute_by_query, #fill_cookie_and_header, #post_json, #query_task_result
Constructor Details
#initialize(server_url, timeout = 120) ⇒ K3CloudApiSdk
10 11 12 13 14 |
# File 'lib/k3cloud_webapi_sdk/main.rb', line 10 def initialize(server_url, timeout = 120) super() @server_url = server_url @timeout = timeout end |
Instance Attribute Details
#server_url ⇒ Object
Returns the value of attribute server_url.
8 9 10 |
# File 'lib/k3cloud_webapi_sdk/main.rb', line 8 def server_url @server_url end |
#timeout ⇒ Object
Returns the value of attribute timeout.
8 9 10 |
# File 'lib/k3cloud_webapi_sdk/main.rb', line 8 def timeout @timeout end |
Instance Method Details
#allocate(formid, data) ⇒ Object
Allocate
130 131 132 133 |
# File 'lib/k3cloud_webapi_sdk/main.rb', line 130 def allocate(formid, data) execute('Kingdee.BOS.WebApi.ServicesStub.DynamicFormService.Allocate', { 'formid' => formid, 'data' => data }) end |
#attachment_download(data) ⇒ Object
Download attachment
208 209 210 211 |
# File 'lib/k3cloud_webapi_sdk/main.rb', line 208 def (data) execute('Kingdee.BOS.WebApi.ServicesStub.DynamicFormService.AttachmentDownLoad', { 'data' => data }) end |
#attachment_upload(data) ⇒ Object
Upload attachment
202 203 204 205 |
# File 'lib/k3cloud_webapi_sdk/main.rb', line 202 def (data) execute('Kingdee.BOS.WebApi.ServicesStub.DynamicFormService.AttachmentUpload', { 'data' => data }) end |
#audit(formid, data) ⇒ Object
Audit
82 83 84 85 |
# File 'lib/k3cloud_webapi_sdk/main.rb', line 82 def audit(formid, data) execute('Kingdee.BOS.WebApi.ServicesStub.DynamicFormService.Audit', { 'formid' => formid, 'data' => data }) end |
#batch_save(formid, data) ⇒ Object
Batch save
69 70 71 72 |
# File 'lib/k3cloud_webapi_sdk/main.rb', line 69 def batch_save(formid, data) execute('Kingdee.BOS.WebApi.ServicesStub.DynamicFormService.BatchSave', { 'formid' => formid, 'data' => data }) end |
#batch_save_query(formid, data) ⇒ Object
Batch save with query
75 76 77 78 79 |
# File 'lib/k3cloud_webapi_sdk/main.rb', line 75 def batch_save_query(formid, data) execute('Kingdee.BOS.WebApi.ServicesStub.DynamicFormService.BatchSave', { 'formid' => formid, 'data' => data }, Const::InvokeMethod::QUERY) end |
#bill_query(data) ⇒ Object
Bill query
118 119 120 121 |
# File 'lib/k3cloud_webapi_sdk/main.rb', line 118 def bill_query(data) execute('Kingdee.BOS.WebApi.ServicesStub.DynamicFormService.BillQuery', { 'data' => data }) end |
#delete(formid, data) ⇒ Object
Delete
88 89 90 91 |
# File 'lib/k3cloud_webapi_sdk/main.rb', line 88 def delete(formid, data) execute('Kingdee.BOS.WebApi.ServicesStub.DynamicFormService.Delete', { 'formid' => formid, 'data' => data }) end |
#disassembly(formid, data) ⇒ Object
Disassembly
160 161 162 163 |
# File 'lib/k3cloud_webapi_sdk/main.rb', line 160 def disassembly(formid, data) execute('Kingdee.BOS.WebApi.ServicesStub.DynamicFormService.Disassembly', { 'formid' => formid, 'data' => data }) end |
#draft(formid, data) ⇒ Object
Draft
124 125 126 127 |
# File 'lib/k3cloud_webapi_sdk/main.rb', line 124 def draft(formid, data) execute('Kingdee.BOS.WebApi.ServicesStub.DynamicFormService.Draft', { 'formid' => formid, 'data' => data }) end |
#execute_bill_query(data) ⇒ Object
Execute bill query
112 113 114 115 |
# File 'lib/k3cloud_webapi_sdk/main.rb', line 112 def execute_bill_query(data) execute('Kingdee.BOS.WebApi.ServicesStub.DynamicFormService.ExecuteBillQuery', { 'data' => data }) end |
#execute_operation(formid, op_number, data) ⇒ Object
Execute operation
57 58 59 60 |
# File 'lib/k3cloud_webapi_sdk/main.rb', line 57 def execute_operation(formid, op_number, data) execute('Kingdee.BOS.WebApi.ServicesStub.DynamicFormService.ExcuteOperation', { 'formid' => formid, 'opNumber' => op_number, 'data' => data }) end |
#flex_save(formid, data) ⇒ Object
Flex save
136 137 138 139 |
# File 'lib/k3cloud_webapi_sdk/main.rb', line 136 def flex_save(formid, data) execute('Kingdee.BOS.WebApi.ServicesStub.DynamicFormService.FlexSave', { 'formid' => formid, 'data' => data }) end |
#get_data_centers ⇒ Object
Get data centers
52 53 54 |
# File 'lib/k3cloud_webapi_sdk/main.rb', line 52 def get_data_centers execute('Kingdee.BOS.ServiceFacade.ServicesStub.Account.AccountService.GetDataCenterList') end |
#get_sys_report_data(formid, data) ⇒ Object
Get system report data
196 197 198 199 |
# File 'lib/k3cloud_webapi_sdk/main.rb', line 196 def get_sys_report_data(formid, data) execute('Kingdee.BOS.WebApi.ServicesStub.DynamicFormService.GetSysReportData', { 'formid' => formid, 'data' => data }) end |
#group_delete(data) ⇒ Object
Group delete
184 185 186 187 |
# File 'lib/k3cloud_webapi_sdk/main.rb', line 184 def group_delete(data) execute('Kingdee.BOS.WebApi.ServicesStub.DynamicFormService.GroupDelete', { 'data' => data }) end |
#group_save(formid, data) ⇒ Object
Group save
154 155 156 157 |
# File 'lib/k3cloud_webapi_sdk/main.rb', line 154 def group_save(formid, data) execute('Kingdee.BOS.WebApi.ServicesStub.DynamicFormService.GroupSave', { 'formid' => formid, 'data' => data }) end |
#init(config_path = 'conf.ini', config_node = 'config') ⇒ Object
Initialize configuration from file
29 30 31 32 |
# File 'lib/k3cloud_webapi_sdk/main.rb', line 29 def init(config_path = 'conf.ini', config_node = 'config') @config = Util::ConfigUtil.init_config(config_path, config_node) init(@server_url, @timeout, is_valid) end |
#init_config(acct_id, user_name, app_id, app_secret, server_url, lcid = 2052, org_num = 0, connect_timeout = 120, request_timeout = 120, proxy = '') ⇒ Object
Initialize configuration with parameters
17 18 19 20 21 22 23 24 25 26 |
# File 'lib/k3cloud_webapi_sdk/main.rb', line 17 def init_config(acct_id, user_name, app_id, app_secret, server_url, lcid = 2052, org_num = 0, connect_timeout = 120, request_timeout = 120, proxy = '') @config = Util::ConfigUtil.init_config_by_params( acct_id, user_name, app_id, app_secret, server_url, lcid, org_num, connect_timeout, request_timeout, proxy ) init(@server_url, @timeout, is_valid) end |
#is_valid ⇒ Object
Check if configuration is valid
35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 |
# File 'lib/k3cloud_webapi_sdk/main.rb', line 35 def is_valid = [] << '账套ID' if @config.dcid.empty? << '用户' if @config.user_name.empty? << '应用ID' if @config.app_id.empty? << '应用密钥' if @config.app_secret.empty? if !.empty? puts 'SDK初始化失败,缺少必填授权项:' + .join(',') return false else return true end end |
#push(formid, data) ⇒ Object
Push
148 149 150 151 |
# File 'lib/k3cloud_webapi_sdk/main.rb', line 148 def push(formid, data) execute('Kingdee.BOS.WebApi.ServicesStub.DynamicFormService.Push', { 'formid' => formid, 'data' => data }) end |
#query_business_info(data) ⇒ Object
Query business info
166 167 168 169 |
# File 'lib/k3cloud_webapi_sdk/main.rb', line 166 def query_business_info(data) execute('Kingdee.BOS.WebApi.ServicesStub.DynamicFormService.QueryBusinessInfo', { 'data' => data }) end |
#query_group_info(data) ⇒ Object
Query group info
172 173 174 175 |
# File 'lib/k3cloud_webapi_sdk/main.rb', line 172 def query_group_info(data) execute('Kingdee.BOS.WebApi.ServicesStub.DynamicFormService.QueryGroupInfo', { 'data' => data }) end |
#save(formid, data) ⇒ Object
Save data
63 64 65 66 |
# File 'lib/k3cloud_webapi_sdk/main.rb', line 63 def save(formid, data) execute('Kingdee.BOS.WebApi.ServicesStub.DynamicFormService.Save', { 'formid' => formid, 'data' => data }) end |
#send_msg(data) ⇒ Object
Send message
142 143 144 145 |
# File 'lib/k3cloud_webapi_sdk/main.rb', line 142 def send_msg(data) execute('Kingdee.BOS.WebApi.ServicesStub.DynamicFormService.SendMsg', { 'data' => data }) end |
#submit(formid, data) ⇒ Object
Submit
100 101 102 103 |
# File 'lib/k3cloud_webapi_sdk/main.rb', line 100 def submit(formid, data) execute('Kingdee.BOS.WebApi.ServicesStub.DynamicFormService.Submit', { 'formid' => formid, 'data' => data }) end |
#switch_org(data) ⇒ Object
Switch organization
190 191 192 193 |
# File 'lib/k3cloud_webapi_sdk/main.rb', line 190 def switch_org(data) execute('Kingdee.BOS.WebApi.ServicesStub.DynamicFormService.SwitchOrg', { 'data' => data }) end |
#un_audit(formid, data) ⇒ Object
Undo audit
94 95 96 97 |
# File 'lib/k3cloud_webapi_sdk/main.rb', line 94 def un_audit(formid, data) execute('Kingdee.BOS.WebApi.ServicesStub.DynamicFormService.UnAudit', { 'formid' => formid, 'data' => data }) end |
#view(formid, data) ⇒ Object
View
106 107 108 109 |
# File 'lib/k3cloud_webapi_sdk/main.rb', line 106 def view(formid, data) execute('Kingdee.BOS.WebApi.ServicesStub.DynamicFormService.View', { 'formid' => formid, 'data' => data }) end |
#workflow_audit(data) ⇒ Object
Workflow audit
178 179 180 181 |
# File 'lib/k3cloud_webapi_sdk/main.rb', line 178 def workflow_audit(data) execute('Kingdee.BOS.WebApi.ServicesStub.DynamicFormService.WorkflowAudit', { 'data' => data }) end |