Page History

...

Description
Workflow package deploy

Parameters

appId - App Idapp ID
version - App Versionapp version
packageXpdl - XPDL file

Sample Result

...

Description
Retrieve package (Appapp) list

Parameters

• callback - a function (in javascriptJavaScript) to call back after invoke invoking this method

Sample Result

{
  "data":
  [
    {
        "packageId":"crm",
        "packageName":"CRM"
    },
    {
        "packageId":"helpdesk",        
        "packageName":"Helpdesk"    
    }  
  ]
}

...

Parameters

• callback - (Optional) A a function (in javascriptJavaScript) to call back after invoke invoking this method
• allVersion - (Optional) "yes" to load all versionversions, "no" to load latest version
• packageId - (Optional) package id (App id)
• sort - (Optional) column name to be sortsorted
• desc - (Optional)  boolean Boolean value to determine either whether to sort by ascending or descending order (true equals to descending)
• start - (Optional)  rows where rows start from
• rows - (Optional) number of rows per page
• checkWhiteList - (Optional true/false) To to return the list based on process white list

...

Parameters

• callback - (Optional) A a function (in javascriptJavaScript) to call back after invoke invoking this method
• checkWhiteList - (Optional) Boolean value to return the list based on process white list

...

Parameters

• callback - (Optional)  A a function (in javascriptJavaScript) to call back after invoke invoking this method
• processDefId - Process Definition Id (Replace '#' with ':' in the id)

...

Parameters

• callback - (Optional) A function a function (in javascriptJavaScript) to call back after invoke invoking this method
• processDefId - Process Definition Id (Replace '#' with ':' in the id)

...

Parameters

• callback - (Optional)  A a function (in javascriptJavaScript) to call back after invoke invoking this method
• processDefId - Process Definition Id (Replace '#' with ':' in the id)
• processInstanceId - (Optional)  Start start process with an instanceId
• var_(workflow variable id) - (Optional) Set set workflow variable value 

Sample Result

...

Parameters

• callback - (Optional) A a function (in javascriptJavaScript) to call back after invoke invoking this method
• processId - process id

...

Parameters

• callback - (Optional) A a function (in javascriptJavaScript) to call back after invoke invoking this method
• processId - process id
• variable - variable id

...

Parameters

• callback - (Optional) A  a function (in javascriptJavaScript) to call back after invoke invoking this method

Sample Result

{"total":"3"}

...

Parameters

• callback - (Optional) A  a function (in javascriptJavaScript) to call back after invoke invoking this method

Sample Result

{"total":"3"}

...

Parameters

• callback - (Optional) A  a function (in javascriptJavaScript) to call back after invoke invoking this method

Sample Result

{"total":"1"}

...

Parameters

• callback - (Optional) A  a function (in javascriptJavaScript) to call back after invoke invoking this method
• processId - (Optional) process definition (Replace '#' with ":" in id)
• sort - (Optional) Column column name to be sortsorted
• desc - (Optional) Boolean value to determine either whether to sort by ascending or descending order (true equals to descending)
• start - (Optional) Rows where rows start from
• rows - (Optional) Number number of rows per page

Sample Result

...

Parameters

• callback - (Optional) A  a function (in javascriptJavaScript) to call back after invoke invoking this method
• processId - (Optional) process definition id (Replace '#' with ":" in id)
• sort - (Optional) Column column name to be sortsorted
• desc - (Optional) Boolean value to determine either whether to sort by ascending or descending order (true equals to descending)
• start - (Optional) Rows where rows start from
• rows - (Optional) Number number of rows per page

Sample Result

...

Parameters

• callback - (Optional) A  a function (in javascriptJavaScript) to call back after invoke invoking this method
• packageId- (Optional) Package id /App Id
• processDefId- (Optional) Process Definition Id with version
• sort - (Optional) Column column name to be sortsorted
• desc - (Optional) Boolean value to determine either whether to sort by ascending or descending order (true equals to descending)
• start - (Optional) Rows where rows start from
• rows - (Optional) Number number of rows per page

Sample Result

...

Parameters

• callback - (Optional) A  a function (in javascriptJavaScript) to call back after invoke invoking this method
• checkWhiteList - (Optional) Boolean value to return the list based on process white list

...

Parameters

• callback - (Optional) A  a function (in javascriptJavaScript) to call back after invoke invoking this method
• checkWhiteList - (Optional) Boolean value to return the list based on process white list

...

Description
Retrieve workflow assignment view

Parameters

• callback - a  a function (in javascriptJavaScript) to call back after invoke invoking this method
• activityId - activity id

...

Parameters

• callback - (Optional) A  a function (in javascriptJavaScript) to call back after invoke invoking this method
• processId - Process Instance ID

...

Description
Retrieve workflow assignment accept

Parameters

• callback - a  a function (in javascriptJavaScript) to call back after invoke invoking this method
• activityId - activity id

...

Parameters

• callback - (Optional) A  a function (in javascriptJavaScript) to call back after invoke invoking this method
• activityId - activity id

...

Description
Set activity variable

Parameters

• callback - a  a function (in javascriptJavaScript) to call back after invoke invoking this method
• activityId - activity id
• variable - variable
• value - value

...

Parameters

• callback - (Optional) A  a function (in javascriptJavaScript) to call back after invoke invoking this method
• activityId - activity id
• var_(workflow variable id) - (Optional) Set set workflow variable value

Sample Code

...

Parameters

• callback - (Optional) A  a function (in javascriptJavaScript) to call back after invoke invoking this method
• activityId - Activity id

...

Parameters

• callback - (Optional) A  a function (in javascriptJavaScript) to call back after invoke invoking this method
• processId - Process id

...

Description
Retrieve process sla SLA list. Work ; works only with Process Data Collector Plugin

...

Description
Retrieve activity sla SLA list. Work ; works only with Process Data Collector Plugin

...

• appId - app id
• appVersion - app version
• processDefId - (Optional) Process process definition id without version

...

Parameters

• packageId - (Optional) Package package id
• processId - (Optional) Process process definition id without version
• processName - (Optional) Process process name
• version - (Optional) Process process version
• sort - (Optional) Column column name to be sortsorted
• desc - (Optional) Boolean value to determine either whether to sort by ascending or descending order (true equals to descending)
• start - (Optional)  Rows where rows start from
• rows - (Optional)  Number number of rows per page

Sample Result

...

Parameters

• packageId - (Optional) Package package id
• processId - (Optional) Process process definition id without version
• processName - (Optional) Process process name
• version - (Optional) Process process version
• sort - (Optional) Column column name to be sortsorted
• desc - (Optional) Boolean value to determine either whether to sort by ascending or descending order (true equals to descending)
• start - (Optional)  Rows where rows start from
• rows - (Optional)  Number number of rows per page

Sample Result

...

Description
Start a process instance with a copy over workflow variable from a running process, and start matching running activity in the new process instance

Parameters

• callback - (Optional) A  a function (in javascriptJavaScript) to call back after invoke invoking this method
• processId - Process process id
• processDefId - Process process definition id
• abortCurrent - (Optional) Boolean value of to indicate whether to abort the running process instance or not

Sample Result

{
  "processDefId":"service_center#4#newpkg1_wp1",
  "processId":"9801_service_center_newpkg1_wp1",
  "activities":[
      "12001_9801_service_center_newpkg1_wp1_newpkg1_wp1_act2"
  ]
}

...

Parameters

• processId - (Optional) Process process id
• sort - (Optional) Column column name to be sortsorted
• desc - (Optional) Boolean value to determine either whether to sort by ascending or descending order (true equals to descending)
• start - (Optional)  Rows where rows start from
• rows - (Optional)  Number number of rows per page

Sample Result

...

Parameters

• callback - (Optional) A  a function (in javascriptJavaScript) to call back after invoke invoking this method
• activityId - Activity id
• variable - Variable
• value - Value

...

Parameters

• callback - (Optional) A  a function (in javascriptJavaScript) to call back after invoke invoking this method
• activityId - Activity id

...

Parameters

• callback - (Optional) A  a function (in javascriptJavaScript) to call back after invoke invoking this method
• processId - process id
• activityDefId - activity definition id

...

Parameters

• callback - (Optional) A  a function (in javascriptJavaScript) to call back after invoke invoking this method
• processId - Process process id
• activityDefId - Activity activity definition id
• abortCurrent - (Optional) Boolean value of to indicate whether to abort current running activity or not

...

Description
Reassign assignee in an assignment

Parameters

• activityId- Activity activity Instance ID
• username- New new assignee (username).
• replaceUser- Assignee assignee to be replaced (username).
• callback - (Optional) A  a function (in javascriptJavaScript) to call back after invoke invoking this method

Sample Result

{
    "activityId": "533_277_crm_process1_approve_proposal",
    "username": "cat",
    "replaceUser": "clark"
}

...

Description
Evaluate assignments for an a user

Parameters

• username - Username

...

Parameters

• callback - (Optional) A  a function (in javascriptJavaScript) to call back after invoke invoking this method

Sample Result

{
    "username":"admin"
}

...

Description
Get a list of published Userviewuser views

Parameters

• appId - (Optional) App ID
• callback - (Optional) A  a function (in javascriptJavaScript) to call back after invoke invoking this method

Sample Result

{
    "apps": [{
        "id": "crm",
        "name": "CRM",
        "userviews": [{
            "id": "crm_userview_sales",
            "name": "CRM: Sales Force Automation",
            "url": "/jw/web/userview/crm/crm_userview_sales",
            "version": 1
        }],
        "version": 1
    }]
}

...

Description
Get a list of published processprocesses

Parameters

• appId - (Optional) App app ID
• callback - (Optional) A  a function (in javascriptJavaScript) to call back after invoke invoking this method

Sample Result

{
    "apps": [{
        "id": "crm",
        "name": "CRM",
        "version": 1,
        "processes": [{
            "id": "crm#1#process1",
            "processVersion": "1",
            "appVersion": 1,
            "name": "Proposal Approval Process",
            "idWithoutVersion": "process1",
            "url": "/jw/web/client/app/crm/1/process/process1?start=true"
        }]
    }]
}