Smartapp.com

WorkFlow

operations about WorkFlow

Starts an Activity

Request
query Parameters
workflowID
required
integer <int64>

workflow ID

Example: workflowID=902172
activityName
required
string

Workflow actvity name that needs to be started

Example: activityName=Inspector/Const. Rep. Signature
Responses
200

success

400

invalid activityId

post/workflow/startactivity
Request samples
Stops an Activity
Request
query Parameters
activityID
required
integer <int64> 
workflow activity id for which you want to stop


 
 Example:  activityID=1782902
Responses
200
success


400
invalid activityId


post/workflow/stopactivity
Request samples
get WorkFlow activites
Request
path Parameters
workflowID
required
integer <int64> 
worfklow id of the activity


 
 Example:  3313
query Parameters
status
string
Filters for status of the workflow activity


 Enum: "pending" "processing" "processed" "active" "cancelled" "on hold" "finalizing" "completed" "error" "stopped"  
Responses
200
returned array of activities


get/workflow/getactivities/{workflowID}
Request samples
Response samples
application/json
[
  • {
    }
]
returns array of workflows asssociated with an item
Request
query Parameters
itemID
required
string <uuid> 
smart item id


 
 Example:  itemID=00000000-0000-0000-0000-000000000000
eventName
string
if event name is passed then it filters for the event


 
 Example:  eventName=Event1
Responses
200
returned an array of workflow


get/workflow/getworkflows
Request samples
Response samples
appication/json
[
  • {
    }
]
sets virtual participants to workflow
Request
query Parameters
workflowID
required
integer <int64> 
workflow id


 
 Example:  workflowID=93485029
required
object (virtualParticipantAssignment) 
virtual participants that need to be assigned to the workflow


 
Responses
200
success


400
Invalid participant name, email, or guid


post/workflow/SetVirtualParticipants
Request samples
Adds participants to workflow activity by name
Request
query Parameters
workflowID
required
integer <int64> 
workflow id


 
 Example:  workflowID=95732950
activityName
required
string
name of the activity


 
 Example:  activityName=activity1
required
Array of objects (participant) 
array of participants


 
Responses
200
success


400
Invalid activity name or participant


404
Activity type  not found


post/workflow/AddParticipantsToActivityByName
Request samples
Adds participants to workflow activity by id
Request
query Parameters
activityID
required
integer <int64> 
activity id


 
 Example:  activityID=9502840
required
Array of objects (participant) 
array of participants


 
Responses
200
success


400
Invalid activityId or participant


404
Workflow activity is not active


post/workflow/AddParticipantsToActivityById
Request samples
performs an action
Request
query Parameters
workItemID
required
integer <int64> 
work item id


 
 Example:  workItemID=17811
action
required
string
workflow action to be performed


 
 Example:  action=Acknowledge
globalUserID
required
string <uuid> 
Global user id of the user


 
 Example:  globalUserID=00000000-0000-0000-0000-000000000000
activityID
integer <int64> 
 
 Example:  activityID=20807
object
ui properties


 
object (workflowComment) 
 
Array of objects (workflowSignature) 
 
Responses
200
success


400
Invalid work item id, work item, or status


post/workflow/performaction
Request samples
Signify to clear activity error
Request
path Parameters
activityID
required
integer <int64> 
activity id for which you want to clear errors


 
 Example:  12456
Responses
200
success


400
Invalid activityId


post/workflow/clearerror/{activityID}
Request samples
Returns a workflow from its id
Request
path Parameters
id
required
integer <int64> 
Work flow id for which the details are required


 
 Example:  4079
Responses
200
returned a workflow object


400
invalid workflowId


get/workflow/get/{id}
Request samples
Response samples
application/json
{
  • "ID": 0,
  • "status": 0,
  • "createdOn": "2019-08-24T14:15:22Z",
  • "activities": [
    ],
  • "virtualParticipants": [
    ],
  • "smartItemID": "823405db-8f6f-46d1-8f58-c2a59333b5cb"
}
Stops all active activities in a workflow
Request
query Parameters
workflowID
required
integer <int64> 
Workflow id for which you want to stop all active activities


 
 Example:  workflowID=1782902
Responses
200
success


404
No active workflow activities for the given workflowId


post/workflow/stopallactivities
Request samples
alerts an activity
Request
query Parameters
workFlowID
required
integer <int64> 
workflow id


 
 Example:  workFlowID=1492
activityID
required
integer <int64> 
activity id


 
 Example:  activityID=20807
outcome
string
 
 Example:  outcome=start
Responses
200
success


400
invalid activityId or workflowId


post/workflow/alertactivity
Request samples
➔ Next to SmartApps