Class: Falcon::WorkflowsApi

Inherits:
Object
  • Object
show all
Defined in:
lib/crimson-falcon/api/workflows_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ WorkflowsApi

Returns a new instance of WorkflowsApi.



36
37
38
 
# File 'lib/crimson-falcon/api/workflows_api.rb', line 36

def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



34
35
36
 
# File 'lib/crimson-falcon/api/workflows_api.rb', line 34

def api_client
  @api_client
end

Instance Method Details

#workflow_definitions_combined(opts = {}) ⇒ DefinitionsDefinitionExternalResponse

Search workflow definitions based on the provided filter

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :filter (String) —

    FQL query specifying filter parameters.

  • :offset (String) —

    Starting pagination offset of records to return.

  • :limit (Integer) —

    Maximum number of records to return.

  • :sort (String) —

    Sort items by providing a comma separated list of property and direction (eg name.desc,time.asc). If direction is omitted, defaults to descending.

Returns:



46
47
48
49
 
# File 'lib/crimson-falcon/api/workflows_api.rb', line 46

def workflow_definitions_combined(opts = {})
  data, _status_code, _headers = workflow_definitions_combined_with_http_info(opts)
  data
end

#workflow_definitions_combined_with_http_info(opts = {}) ⇒ Array<(DefinitionsDefinitionExternalResponse, Integer, Hash)>

Search workflow definitions based on the provided filter

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :filter (String) —

    FQL query specifying filter parameters.

  • :offset (String) —

    Starting pagination offset of records to return.

  • :limit (Integer) —

    Maximum number of records to return.

  • :sort (String) —

    Sort items by providing a comma separated list of property and direction (eg name.desc,time.asc). If direction is omitted, defaults to descending.

Returns:



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
 
# File 'lib/crimson-falcon/api/workflows_api.rb', line 58

def workflow_definitions_combined_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: WorkflowsApi.workflow_definitions_combined ...'
  end
  pattern = Regexp.new(/^\w+(\.asc|\.desc)?(,\w+(\.asc|\.desc)?)*$/)
  if @api_client.config.client_side_validation && !opts[:'sort'].nil? && opts[:'sort'] !~ pattern
    fail ArgumentError, "invalid value for 'opts[:\"sort\"]' when calling WorkflowsApi.workflow_definitions_combined, must conform to the pattern #{pattern}."
  end

  # resource path
  local_var_path = '/workflows/combined/definitions/v1'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'filter'] = opts[:'filter'] if !opts[:'filter'].nil?
  query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
  query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'DefinitionsDefinitionExternalResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['oauth2']

  new_options = opts.merge(
    :operation => :"WorkflowsApi.workflow_definitions_combined",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: WorkflowsApi#workflow_definitions_combined\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#workflow_definitions_create(body, opts = {}) ⇒ ApiResourceIDsResponse

Creates a workflow definition based on the provided model

Parameters:

Options Hash (opts):

  • :validate_only (Boolean) —

    When enabled, prevents saving workflow after validating (default to false)

Returns:



116
117
118
119
 
# File 'lib/crimson-falcon/api/workflows_api.rb', line 116

def workflow_definitions_create(body, opts = {})
  data, _status_code, _headers = workflow_definitions_create_with_http_info(body, opts)
  data
end

#workflow_definitions_create_with_http_info(body, opts = {}) ⇒ Array<(ApiResourceIDsResponse, Integer, Hash)>

Creates a workflow definition based on the provided model

Parameters:

Options Hash (opts):

  • :validate_only (Boolean) —

    When enabled, prevents saving workflow after validating (default to false)

Returns:

  • (Array<(ApiResourceIDsResponse, Integer, Hash)>) —

    ApiResourceIDsResponse data, response status code and response headers



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
 
# File 'lib/crimson-falcon/api/workflows_api.rb', line 126

def workflow_definitions_create_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: WorkflowsApi.workflow_definitions_create ...'
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling WorkflowsApi.workflow_definitions_create"
  end
  # resource path
  local_var_path = '/workflows/entities/definitions/v1'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'validate_only'] = opts[:'validate_only'] if !opts[:'validate_only'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json', 'application/yaml'])
  if !content_type.nil?
    header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(body)

  # return_type
  return_type = opts[:debug_return_type] || 'ApiResourceIDsResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['oauth2']

  new_options = opts.merge(
    :operation => :"WorkflowsApi.workflow_definitions_create",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: WorkflowsApi#workflow_definitions_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#workflow_definitions_export(id, opts = {}) ⇒ Array<Integer>

Exports a workflow definition for the given definition ID

Parameters:

  • id (String) —

    ID of workflow definitions to return details for

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<Integer>) 


184
185
186
187
 
# File 'lib/crimson-falcon/api/workflows_api.rb', line 184

def workflow_definitions_export(id, opts = {})
  data, _status_code, _headers = workflow_definitions_export_with_http_info(id, opts)
  data
end

#workflow_definitions_export_with_http_info(id, opts = {}) ⇒ Array<(Array<Integer>, Integer, Hash)>

Exports a workflow definition for the given definition ID

Parameters:

  • id (String) —

    ID of workflow definitions to return details for

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(Array<Integer>, Integer, Hash)>) —

    Array<Integer> data, response status code and response headers



193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
 
# File 'lib/crimson-falcon/api/workflows_api.rb', line 193

def workflow_definitions_export_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: WorkflowsApi.workflow_definitions_export ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling WorkflowsApi.workflow_definitions_export"
  end
  if @api_client.config.client_side_validation && id.to_s.length > 40
    fail ArgumentError, 'invalid value for "id" when calling WorkflowsApi.workflow_definitions_export, the character length must be smaller than or equal to 40.'
  end

  if @api_client.config.client_side_validation && id.to_s.length < 32
    fail ArgumentError, 'invalid value for "id" when calling WorkflowsApi.workflow_definitions_export, the character length must be great than or equal to 32.'
  end

  # resource path
  local_var_path = '/workflows/entities/definitions/export/v1'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'id'] = id

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/yaml'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'Array<Integer>'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['oauth2']

  new_options = opts.merge(
    :operation => :"WorkflowsApi.workflow_definitions_export",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: WorkflowsApi#workflow_definitions_export\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#workflow_definitions_import(data_file, opts = {}) ⇒ DefinitionsDefinitionImportResponse

Imports a workflow definition based on the provided model

Parameters:

  • data_file (File) —

    A workflow definition in YAML format to import

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :name (String) —

    Workflow name to override

  • :validate_only (Boolean) —

    When enabled, prevents saving workflow after validating (default to false)

Returns:



256
257
258
259
 
# File 'lib/crimson-falcon/api/workflows_api.rb', line 256

def workflow_definitions_import(data_file, opts = {})
  data, _status_code, _headers = workflow_definitions_import_with_http_info(data_file, opts)
  data
end

#workflow_definitions_import_with_http_info(data_file, opts = {}) ⇒ Array<(DefinitionsDefinitionImportResponse, Integer, Hash)>

Imports a workflow definition based on the provided model

Parameters:

  • data_file (File) —

    A workflow definition in YAML format to import

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :name (String) —

    Workflow name to override

  • :validate_only (Boolean) —

    When enabled, prevents saving workflow after validating (default to false)

Returns:



267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
 
# File 'lib/crimson-falcon/api/workflows_api.rb', line 267

def workflow_definitions_import_with_http_info(data_file, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: WorkflowsApi.workflow_definitions_import ...'
  end
  # verify the required parameter 'data_file' is set
  if @api_client.config.client_side_validation && data_file.nil?
    fail ArgumentError, "Missing the required parameter 'data_file' when calling WorkflowsApi.workflow_definitions_import"
  end
  # resource path
  local_var_path = '/workflows/entities/definitions/import/v1'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'name'] = opts[:'name'] if !opts[:'name'].nil?
  query_params[:'validate_only'] = opts[:'validate_only'] if !opts[:'validate_only'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['multipart/form-data'])
  if !content_type.nil?
    header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}
  form_params['data_file'] = data_file

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'DefinitionsDefinitionImportResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['oauth2']

  new_options = opts.merge(
    :operation => :"WorkflowsApi.workflow_definitions_import",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: WorkflowsApi#workflow_definitions_import\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#workflow_definitions_update(body, opts = {}) ⇒ ApiResourceIDsResponse

Updates a workflow definition based on the provided model

Parameters:

Options Hash (opts):

  • :validate_only (Boolean) —

    When enabled, prevents saving workflow after validating (default to false)

Returns:



328
329
330
331
 
# File 'lib/crimson-falcon/api/workflows_api.rb', line 328

def workflow_definitions_update(body, opts = {})
  data, _status_code, _headers = workflow_definitions_update_with_http_info(body, opts)
  data
end

#workflow_definitions_update_with_http_info(body, opts = {}) ⇒ Array<(ApiResourceIDsResponse, Integer, Hash)>

Updates a workflow definition based on the provided model

Parameters:

Options Hash (opts):

  • :validate_only (Boolean) —

    When enabled, prevents saving workflow after validating (default to false)

Returns:

  • (Array<(ApiResourceIDsResponse, Integer, Hash)>) —

    ApiResourceIDsResponse data, response status code and response headers



338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
 
# File 'lib/crimson-falcon/api/workflows_api.rb', line 338

def workflow_definitions_update_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: WorkflowsApi.workflow_definitions_update ...'
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling WorkflowsApi.workflow_definitions_update"
  end
  # resource path
  local_var_path = '/workflows/entities/definitions/v1'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'validate_only'] = opts[:'validate_only'] if !opts[:'validate_only'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json', 'application/yaml'])
  if !content_type.nil?
    header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(body)

  # return_type
  return_type = opts[:debug_return_type] || 'ApiResourceIDsResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['oauth2']

  new_options = opts.merge(
    :operation => :"WorkflowsApi.workflow_definitions_update",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: WorkflowsApi#workflow_definitions_update\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#workflow_execute(body, opts = {}) ⇒ ApiResourceIDsResponse

Executes an on-demand Workflow, the body is JSON used to trigger the execution, the response the execution ID(s)

Parameters:

  • body (Object)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :execution_cid (Array<String>) —

    CID(s) to execute on. This can be a child if this is a flight control enabled definition. If unset the definition CID is used.

  • :definition_id (Array<String>) —

    Definition ID to execute, either a name or an ID can be specified.

  • :name (String) —

    Workflow name to execute, either a name or an ID can be specified.

  • :key (String) —

    Key used to help deduplicate executions, if unset a new UUID is used

  • :depth (Integer) —

    Used to record the execution depth to help limit execution loops when a workflow triggers another. The maximum depth is 4.

  • :source_event_url (String) —

    Used to record a URL to the source that led to triggering this workflow

Returns:



402
403
404
405
 
# File 'lib/crimson-falcon/api/workflows_api.rb', line 402

def workflow_execute(body, opts = {})
  data, _status_code, _headers = workflow_execute_with_http_info(body, opts)
  data
end

#workflow_execute_with_http_info(body, opts = {}) ⇒ Array<(ApiResourceIDsResponse, Integer, Hash)>

Executes an on-demand Workflow, the body is JSON used to trigger the execution, the response the execution ID(s)

Parameters:

  • body (Object)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :execution_cid (Array<String>) —

    CID(s) to execute on. This can be a child if this is a flight control enabled definition. If unset the definition CID is used.

  • :definition_id (Array<String>) —

    Definition ID to execute, either a name or an ID can be specified.

  • :name (String) —

    Workflow name to execute, either a name or an ID can be specified.

  • :key (String) —

    Key used to help deduplicate executions, if unset a new UUID is used

  • :depth (Integer) —

    Used to record the execution depth to help limit execution loops when a workflow triggers another. The maximum depth is 4.

  • :source_event_url (String) —

    Used to record a URL to the source that led to triggering this workflow

Returns:

  • (Array<(ApiResourceIDsResponse, Integer, Hash)>) —

    ApiResourceIDsResponse data, response status code and response headers



417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
 
# File 'lib/crimson-falcon/api/workflows_api.rb', line 417

def workflow_execute_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: WorkflowsApi.workflow_execute ...'
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling WorkflowsApi.workflow_execute"
  end
  # resource path
  local_var_path = '/workflows/entities/execute/v1'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'execution_cid'] = @api_client.build_collection_param(opts[:'execution_cid'], :csv) if !opts[:'execution_cid'].nil?
  query_params[:'definition_id'] = @api_client.build_collection_param(opts[:'definition_id'], :csv) if !opts[:'definition_id'].nil?
  query_params[:'name'] = opts[:'name'] if !opts[:'name'].nil?
  query_params[:'key'] = opts[:'key'] if !opts[:'key'].nil?
  query_params[:'depth'] = opts[:'depth'] if !opts[:'depth'].nil?
  query_params[:'source_event_url'] = opts[:'source_event_url'] if !opts[:'source_event_url'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
    header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(body)

  # return_type
  return_type = opts[:debug_return_type] || 'ApiResourceIDsResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['oauth2']

  new_options = opts.merge(
    :operation => :"WorkflowsApi.workflow_execute",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: WorkflowsApi#workflow_execute\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#workflow_execution_results(ids, opts = {}) ⇒ ApiExecutionResultsResponse

Get execution result of a given execution

Parameters:

  • ids (Array<String>) —

    workflow execution id to return results for.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



480
481
482
483
 
# File 'lib/crimson-falcon/api/workflows_api.rb', line 480

def workflow_execution_results(ids, opts = {})
  data, _status_code, _headers = workflow_execution_results_with_http_info(ids, opts)
  data
end

#workflow_execution_results_with_http_info(ids, opts = {}) ⇒ Array<(ApiExecutionResultsResponse, Integer, Hash)>

Get execution result of a given execution

Parameters:

  • ids (Array<String>) —

    workflow execution id to return results for.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(ApiExecutionResultsResponse, Integer, Hash)>) —

    ApiExecutionResultsResponse data, response status code and response headers



489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
 
# File 'lib/crimson-falcon/api/workflows_api.rb', line 489

def workflow_execution_results_with_http_info(ids, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: WorkflowsApi.workflow_execution_results ...'
  end
  # verify the required parameter 'ids' is set
  if @api_client.config.client_side_validation && ids.nil?
    fail ArgumentError, "Missing the required parameter 'ids' when calling WorkflowsApi.workflow_execution_results"
  end
  if @api_client.config.client_side_validation && ids.length > 500
    fail ArgumentError, 'invalid value for "ids" when calling WorkflowsApi.workflow_execution_results, number of items must be less than or equal to 500.'
  end

  if @api_client.config.client_side_validation && ids.length < 1
    fail ArgumentError, 'invalid value for "ids" when calling WorkflowsApi.workflow_execution_results, number of items must be greater than or equal to 1.'
  end

  # resource path
  local_var_path = '/workflows/entities/execution-results/v1'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'ids'] = @api_client.build_collection_param(ids, :csv)

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'ApiExecutionResultsResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['oauth2']

  new_options = opts.merge(
    :operation => :"WorkflowsApi.workflow_execution_results",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: WorkflowsApi#workflow_execution_results\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#workflow_executions_action(action_name, body, opts = {}) ⇒ DefinitionsDefinitionEntitiesResponse

Allows a user to resume/retry a failed workflow execution.

Parameters:

  • action_name (String) —

    Specify one of these actions: - &#x60;resume&#x60;: resume/retry the workflow execution(s) specified in ids

  • body (ClientActionRequest)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



551
552
553
554
 
# File 'lib/crimson-falcon/api/workflows_api.rb', line 551

def workflow_executions_action(action_name, body, opts = {})
  data, _status_code, _headers = workflow_executions_action_with_http_info(action_name, body, opts)
  data
end

#workflow_executions_action_with_http_info(action_name, body, opts = {}) ⇒ Array<(DefinitionsDefinitionEntitiesResponse, Integer, Hash)>

Allows a user to resume/retry a failed workflow execution.

Parameters:

  • action_name (String) —

    Specify one of these actions: - &#x60;resume&#x60;: resume/retry the workflow execution(s) specified in ids

  • body (ClientActionRequest)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
 
# File 'lib/crimson-falcon/api/workflows_api.rb', line 561

def workflow_executions_action_with_http_info(action_name, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: WorkflowsApi.workflow_executions_action ...'
  end
  # verify the required parameter 'action_name' is set
  if @api_client.config.client_side_validation && action_name.nil?
    fail ArgumentError, "Missing the required parameter 'action_name' when calling WorkflowsApi.workflow_executions_action"
  end
  # verify enum value
  allowable_values = ["resume"]
  if @api_client.config.client_side_validation && !allowable_values.include?(action_name)
    fail ArgumentError, "invalid value for \"action_name\", must be one of #{allowable_values}"
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling WorkflowsApi.workflow_executions_action"
  end
  # resource path
  local_var_path = '/workflows/entities/execution-actions/v1'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'action_name'] = action_name

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
    header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(body)

  # return_type
  return_type = opts[:debug_return_type] || 'DefinitionsDefinitionEntitiesResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['oauth2']

  new_options = opts.merge(
    :operation => :"WorkflowsApi.workflow_executions_action",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: WorkflowsApi#workflow_executions_action\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#workflow_executions_combined(opts = {}) ⇒ ApiExecutionResultsResponse

Search workflow executions based on the provided filter

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :filter (String) —

    FQL query specifying filter parameters.

  • :offset (String) —

    Starting pagination offset of records to return.

  • :limit (Integer) —

    Maximum number of records to return.

  • :sort (String) —

    Sort items by providing a comma separated list of property and direction (eg name.desc,time.asc). If direction is omitted, defaults to descending.

Returns:



631
632
633
634
 
# File 'lib/crimson-falcon/api/workflows_api.rb', line 631

def workflow_executions_combined(opts = {})
  data, _status_code, _headers = workflow_executions_combined_with_http_info(opts)
  data
end

#workflow_executions_combined_with_http_info(opts = {}) ⇒ Array<(ApiExecutionResultsResponse, Integer, Hash)>

Search workflow executions based on the provided filter

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :filter (String) —

    FQL query specifying filter parameters.

  • :offset (String) —

    Starting pagination offset of records to return.

  • :limit (Integer) —

    Maximum number of records to return.

  • :sort (String) —

    Sort items by providing a comma separated list of property and direction (eg name.desc,time.asc). If direction is omitted, defaults to descending.

Returns:

  • (Array<(ApiExecutionResultsResponse, Integer, Hash)>) —

    ApiExecutionResultsResponse data, response status code and response headers



643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
 
# File 'lib/crimson-falcon/api/workflows_api.rb', line 643

def workflow_executions_combined_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: WorkflowsApi.workflow_executions_combined ...'
  end
  pattern = Regexp.new(/^\w+(\.asc|\.desc)?(,\w+(\.asc|\.desc)?)*$/)
  if @api_client.config.client_side_validation && !opts[:'sort'].nil? && opts[:'sort'] !~ pattern
    fail ArgumentError, "invalid value for 'opts[:\"sort\"]' when calling WorkflowsApi.workflow_executions_combined, must conform to the pattern #{pattern}."
  end

  # resource path
  local_var_path = '/workflows/combined/executions/v1'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'filter'] = opts[:'filter'] if !opts[:'filter'].nil?
  query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
  query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'ApiExecutionResultsResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['oauth2']

  new_options = opts.merge(
    :operation => :"WorkflowsApi.workflow_executions_combined",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: WorkflowsApi#workflow_executions_combined\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#workflow_get_human_input_v1(ids, opts = {}) ⇒ ModelUserInputReadResponse

Gets one or more specific human inputs by their IDs.

Parameters:

  • ids (Array<String>) —

    IDs of human inputs to read

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



700
701
702
703
 
# File 'lib/crimson-falcon/api/workflows_api.rb', line 700

def workflow_get_human_input_v1(ids, opts = {})
  data, _status_code, _headers = workflow_get_human_input_v1_with_http_info(ids, opts)
  data
end

#workflow_get_human_input_v1_with_http_info(ids, opts = {}) ⇒ Array<(ModelUserInputReadResponse, Integer, Hash)>

Gets one or more specific human inputs by their IDs.

Parameters:

  • ids (Array<String>) —

    IDs of human inputs to read

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(ModelUserInputReadResponse, Integer, Hash)>) —

    ModelUserInputReadResponse data, response status code and response headers



709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
 
# File 'lib/crimson-falcon/api/workflows_api.rb', line 709

def workflow_get_human_input_v1_with_http_info(ids, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: WorkflowsApi.workflow_get_human_input_v1 ...'
  end
  # verify the required parameter 'ids' is set
  if @api_client.config.client_side_validation && ids.nil?
    fail ArgumentError, "Missing the required parameter 'ids' when calling WorkflowsApi.workflow_get_human_input_v1"
  end
  # resource path
  local_var_path = '/workflows/entities/human-inputs/v1'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'ids'] = @api_client.build_collection_param(ids, :csv)

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'ModelUserInputReadResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['oauth2']

  new_options = opts.merge(
    :operation => :"WorkflowsApi.workflow_get_human_input_v1",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: WorkflowsApi#workflow_get_human_input_v1\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#workflow_system_definitions_de_provision(body, opts = {}) ⇒ ClientSystemDefinitionCreateResponse

Deprovisions a system definition that was previously provisioned on the target CID

Parameters:

Returns:



762
763
764
765
 
# File 'lib/crimson-falcon/api/workflows_api.rb', line 762

def workflow_system_definitions_de_provision(body, opts = {})
  data, _status_code, _headers = workflow_system_definitions_de_provision_with_http_info(body, opts)
  data
end

#workflow_system_definitions_de_provision_with_http_info(body, opts = {}) ⇒ Array<(ClientSystemDefinitionCreateResponse, Integer, Hash)>

Deprovisions a system definition that was previously provisioned on the target CID

Parameters:

Returns:



771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
 
# File 'lib/crimson-falcon/api/workflows_api.rb', line 771

def workflow_system_definitions_de_provision_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: WorkflowsApi.workflow_system_definitions_de_provision ...'
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling WorkflowsApi.workflow_system_definitions_de_provision"
  end
  # resource path
  local_var_path = '/workflows/system-definitions/deprovision/v1'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
    header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(body)

  # return_type
  return_type = opts[:debug_return_type] || 'ClientSystemDefinitionCreateResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['oauth2']

  new_options = opts.merge(
    :operation => :"WorkflowsApi.workflow_system_definitions_de_provision",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: WorkflowsApi#workflow_system_definitions_de_provision\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#workflow_system_definitions_promote(body, opts = {}) ⇒ ClientSystemDefinitionCreateResponse

Promotes a version of a system definition for a customer. The customer must already have been provisioned. This allows the caller to apply an updated template version to a specific cid and expects all parameters to be supplied. If the template supports multi-instance the customer scope definition ID must be supplied to determine which customer workflow should be updated.

Parameters:

Returns:



828
829
830
831
 
# File 'lib/crimson-falcon/api/workflows_api.rb', line 828

def workflow_system_definitions_promote(body, opts = {})
  data, _status_code, _headers = workflow_system_definitions_promote_with_http_info(body, opts)
  data
end

#workflow_system_definitions_promote_with_http_info(body, opts = {}) ⇒ Array<(ClientSystemDefinitionCreateResponse, Integer, Hash)>

Promotes a version of a system definition for a customer. The customer must already have been provisioned. This allows the caller to apply an updated template version to a specific cid and expects all parameters to be supplied. If the template supports multi-instance the customer scope definition ID must be supplied to determine which customer workflow should be updated.

Parameters:

Returns:



837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
 
# File 'lib/crimson-falcon/api/workflows_api.rb', line 837

def workflow_system_definitions_promote_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: WorkflowsApi.workflow_system_definitions_promote ...'
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling WorkflowsApi.workflow_system_definitions_promote"
  end
  # resource path
  local_var_path = '/workflows/system-definitions/promote/v1'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
    header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(body)

  # return_type
  return_type = opts[:debug_return_type] || 'ClientSystemDefinitionCreateResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['oauth2']

  new_options = opts.merge(
    :operation => :"WorkflowsApi.workflow_system_definitions_promote",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: WorkflowsApi#workflow_system_definitions_promote\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#workflow_system_definitions_provision(body, opts = {}) ⇒ ClientSystemDefinitionCreateResponse

Provisions a system definition onto the target CID by using the template and provided parameters

Parameters:

Returns:



894
895
896
897
 
# File 'lib/crimson-falcon/api/workflows_api.rb', line 894

def workflow_system_definitions_provision(body, opts = {})
  data, _status_code, _headers = workflow_system_definitions_provision_with_http_info(body, opts)
  data
end

#workflow_system_definitions_provision_with_http_info(body, opts = {}) ⇒ Array<(ClientSystemDefinitionCreateResponse, Integer, Hash)>

Provisions a system definition onto the target CID by using the template and provided parameters

Parameters:

Returns:



903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
 
# File 'lib/crimson-falcon/api/workflows_api.rb', line 903

def workflow_system_definitions_provision_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: WorkflowsApi.workflow_system_definitions_provision ...'
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling WorkflowsApi.workflow_system_definitions_provision"
  end
  # resource path
  local_var_path = '/workflows/system-definitions/provision/v1'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
    header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(body)

  # return_type
  return_type = opts[:debug_return_type] || 'ClientSystemDefinitionCreateResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['oauth2']

  new_options = opts.merge(
    :operation => :"WorkflowsApi.workflow_system_definitions_provision",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: WorkflowsApi#workflow_system_definitions_provision\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#workflow_update_human_input_v1(id, body, opts = {}) ⇒ ApiResourceIDsResponse

Provides an input in response to a human input action. Depending on action configuration, one or more of Approve, Decline, and/or Escalate are permitted.

Parameters:

  • id (String) —

    ID of human input to provide an input to

  • body (ModelUserInputUpdateRequest)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



961
962
963
964
 
# File 'lib/crimson-falcon/api/workflows_api.rb', line 961

def workflow_update_human_input_v1(id, body, opts = {})
  data, _status_code, _headers = workflow_update_human_input_v1_with_http_info(id, body, opts)
  data
end

#workflow_update_human_input_v1_with_http_info(id, body, opts = {}) ⇒ Array<(ApiResourceIDsResponse, Integer, Hash)>

Provides an input in response to a human input action. Depending on action configuration, one or more of Approve, Decline, and/or Escalate are permitted.

Parameters:

  • id (String) —

    ID of human input to provide an input to

  • body (ModelUserInputUpdateRequest)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(ApiResourceIDsResponse, Integer, Hash)>) —

    ApiResourceIDsResponse data, response status code and response headers



971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
 
# File 'lib/crimson-falcon/api/workflows_api.rb', line 971

def workflow_update_human_input_v1_with_http_info(id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: WorkflowsApi.workflow_update_human_input_v1 ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling WorkflowsApi.workflow_update_human_input_v1"
  end
  if @api_client.config.client_side_validation && id.to_s.length > 32
    fail ArgumentError, 'invalid value for "id" when calling WorkflowsApi.workflow_update_human_input_v1, the character length must be smaller than or equal to 32.'
  end

  if @api_client.config.client_side_validation && id.to_s.length < 32
    fail ArgumentError, 'invalid value for "id" when calling WorkflowsApi.workflow_update_human_input_v1, the character length must be great than or equal to 32.'
  end

  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling WorkflowsApi.workflow_update_human_input_v1"
  end
  # resource path
  local_var_path = '/workflows/entities/human-inputs/v1'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'id'] = id

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
    header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(body)

  # return_type
  return_type = opts[:debug_return_type] || 'ApiResourceIDsResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['oauth2']

  new_options = opts.merge(
    :operation => :"WorkflowsApi.workflow_update_human_input_v1",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:PATCH, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: WorkflowsApi#workflow_update_human_input_v1\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end