Webinar

November 3rd, 2021 12:00 PM EDT
Automation for Field Services & DistributionNovember 3rd, 2021 12:00 PM EDT
Learn how creating a digital workforce can improve your supply chain processes!

Create Input Work Item

Create an input work item for a process

Arguments

Argument Type Default value Description
payloadAny, NoneNone
filesstr, List, NoneNone
process_idstr, NoneNone
param payload:work item data
param files:absolute filepaths as single string or list
param process_id:
 specific process to which item belongs to

Get Process Id By Name

Get a process id of the process by name

Arguments

Argument Type Default value Description
process_namestrnull
workspace_idstr, NoneNone
param process_name:
 name of the process in the Control Room
param workspace_id:
 specific Control Room workspace to which process belongs to

Get Process Run Status

Get a process run status by run id

Arguments

Argument Type Default value Description
process_run_idstrnull
process_idstr, NoneNone
param process_run_id:
 id of the process run
param process_id:
 specific process to which runs belongs to

Get Work Item

Get work item from Control Room

Arguments

Argument Type Default value Description
workitem_idstrnull
include_databoolFalse
process_idstr, NoneNone
param workitem_id:
 id of the work item
param include_data:
 include work item payload and files in the response (default False)
param process_id:
 specific process to which runs belongs to

List Process Runs

List of runs related to a process

Arguments

Argument Type Default value Description
run_statestr, NoneNone
limitint, None10
process_idstr, NoneNone
param run_state:
 state of runs to return (default all)
param limit:number of runs to return (default 10)
param process_id:
 specific process to which runs belongs to

List Process Runs In Workspace

List all process runs in a workspace

Arguments

Argument Type Default value Description
run_statestr, NoneNone
limitint, None10
workspace_idstr, NoneNone
param run_state:
 state of runs to return (default all)
param limit:number of runs to return (default 10)
param workspace_id:
 specific Control Room workspace to which process belongs to

List Process Work Items

List work items belonging to a process

Arguments

Argument Type Default value Description
process_idstr, NoneNone
include_databoolFalse
item_statestr, NoneNone
param include_data:
 include work item payload and files in the response (default False)
param item_state:
 state of work items to return (default all)
param process_id:
 specific process to which items belongs to

List Processes

List all processes in a workspace

Arguments

Argument Type Default value Description
workspace_idstr, NoneNone
param workspace_id:
 specific Control Room workspace to which process belongs to

Retry Work Item

Retry processing of work item in FAILED state

Arguments

Argument Type Default value Description
work_item_idstrnull
process_idstr, NoneNone
param work_item_id:
 ID of the work item to retry
param process_id:
 specific process to start

Set Apikey

Set Workspace API access key

Arguments

Argument Type Default value Description
apikeystr, NoneNone
param apikey:workspace API access key

Set Credentials

Set credentials needed by the Process API

Arguments

Argument Type Default value Description
workspace_idstr, NoneNone
process_idstr, NoneNone
apikeystr, NoneNone
param workspace_id:
 ID of the Control Room workspace
param process_id:
 ID of the Control Room process
param apikey:workspace API access key

Set Process Id

Set Control Room process ID

Arguments

Argument Type Default value Description
process_idstr, NoneNone
param process_id:
 ID of the Control Room process

Set Workspace Id

Set Control Room workspace ID

Arguments

Argument Type Default value Description
workspace_idstr, NoneNone
param workspace_id:
 ID of the Control Room workspace

Start Configured Process

Start a Control Room process with the provided configuration

Arguments

Argument Type Default value Description
config_typeConfigurationTypedefault
extra_infostr, List, NoneNone
process_idstr, NoneNone
param config_type:
 type of the start, (ConfigurationType.default)
param extra_info:
 data to be sent with the start, for example. work item IDs
param process_id:
 specific process to start

Start Process

Start a Control Room process

Arguments

Argument Type Default value Description
work_itemsDict, List[typing.Dict], NoneNone
batchboolFalse
process_idstr, NoneNone
param work_items:
 input work items for the process (default empty)
param batch:set to True if sending list of workitems to start each as a separate run
param process_id:
 specific process to start