Page Comparison

...

Generates an authentication token to authorize users later. Generated token can be use to "auth" parameter to authorise users without login requirement.

Required Scope

login

Parameters

Parameter Name	Description
apiKey	Caller system identifier.
logonId	User logon id
logonProvider	User logon provider.

...

Returns the list of work items on user's worklist. Tag parameter specifies the identifier of which list should be return.

Required Scope

worklist_read

Parameters

Parameter Name	Description
apiKey	Caller system identifier.
logonId	User logon id
logonProvider	User logon provider.
tag	Worklist identifier. If set to null default inbox is returned.
start	Start number of list. Use 0 to start from beginning.
maxLength	Limit of number of rows in list. Use -1 to get all rows.
queryXml	Optional query xml value. See Query for more details.

...

Returns number of records in worklist. You can use this method to specify paging parameters in GetWorkList method.

Required Scope

worklist_read

Parameters

Parameter Name	Description
apiKey	Caller system identifier.
logonId	User logon id
logonProvider	User logon provider.
tag	Worklist identifier. If set to null default inbox is returned.
queryXml	Optional query xml value. See Query for more details.

...

Gets workitem information to display or complete with action.

Required Scope

worklist_read

Parameters

Parameter Name	Description
apiKey	Caller system identifier.
logonId	User logon id
logonProvider	User logon provider.
id	Work item identifier.
readOnly	Set true to fetch work item read only. Default is false.

...

Request

Response

No Format
POST http://ertan.emakin.com/rest/getWorkItem { "apiKey": "xxxx", "logonId": "user@emakin.com", "logonProvider": "Organization", "id": "e5134318-88bd-4a33-b561-4d78380734ce" }

No Format

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

{
     "d": {
         "Id": "e5134318-88bd-4a33-b561-4d78380734ce",
         "Caption": "A new task",
         "Culture": "en-US",
         "Start": "/Date(1445812020394)/",
         "End": null,
         "DeadlineDate": null,
         "InstanceNumber": 12471,
         "IsReadOnly": false,
         "SelectedActionId": null,
         "Actions": [
             {
                 "Id": "2b0aa720-82f8-4a62-b7a1-2389203fa5e7",
                 "Name": "Complete",
                 "Color": "",
                 "BackgroundColor": "",
                 "Order": 1,
                 "Hidden" : false,
                 "RequireComment": false,
                 "ConfirmationMessage": "",
                 "ValidationGroup": ""
             },
             {
                 "Id": "c5350e5c-6e03-4b72-9522-49ab7f849b8a",
                 "Name": "Cancel",
                 "Color": "",
                 "BackgroundColor": "",
                 "Order": 2,
                 "Hidden" : false,
                 "RequireComment": true,
                 "ConfirmationMessage": "",
                 "ValidationGroup": ""
             }
         ]
     }
 }

GetWorkItemData

...

SelectAction

Selects an action on a work item and returns array of next work item identifiers.

Required Scope

workitem_action

Parameters

Parameter Name	Description
apiKey	Caller system identifier.
logonId	User logon id
logonProvider	User logon provider.
id	Work item identifier.

Example Call

...

No Format
POST http://ertan.emakin.com/rest/getWorkItemData { "apiKey": "xxxx", "logonId": "user@emakin.com", "logonProvider": "Organization", "id": "e5134318-88bd-4a33-b561-4d78380734ce" }

No Format
HTTP/1.1 200 OK Content-Type: application/json; charset=utf-8 { "d": { "Data": "<xml><poolRoot>.....</poolRoot></xml>", "DataRoot": "poolRoot" } }

SelectAction

Selects an action on a work item and returns array of next work item identifiers.

Parameters

Parameter Name	Description
apiKey	Caller system identifier.
logonId	User logon id
logonProvider	User logon provider.
id	Work item identifier.
action	Action identifier.
data	XML dataaction	Action identifier.
data	XML data. Can be null. (There is no merge operation. Whole form data should be sent otherwise the form data is replaced with the new data. The data can be retrieved by *GetWorkItemData* method. The final data should be send inside of a form element. e.g. <form><Data>...</Data></form>)
comments	User comments

Example Call

Request

Response

No Format

POST http://ertan.emakin.com/rest/selectAction

{
     "apiKey": "xxxx",
     "logonId": "user@emakin.com",
     "logonProvider": "Organization",
     "id": "e5134318-88bd-4a33-b561-4d78380734ce",
     "action": "c5350e5c-6e03-4b72-9522-49ab7f849b8a",
     "data": null
}

No Format
HTTP/1.1 200 OK Content-Type: application/json; charset=utf-8 { "d": [ "716F8FCB-98C2-4591-8C43-043D54DEAADA" ] }

...

Initiates a new process instance with specified parameters and returns the Id number of work item.When testing this method with Soap UI, you must include the xml for the data parameter inside <![CDATA[]]>, for example: <![CDATA[<pool><myField>ABC</myField></pool>]]>

Required Scope

process_initiate

Parameters

Parameter Name	Description
apiKey	Caller system identifier.
logonId	User logon id
logonProvider	User logon provider.
process	Name or Id number of process
task	Name or Id number of task
version	Version number or id of process. Can be null.
data	XML data. Can be null.
culture	Culture preference. Can be null.

Example Call

Request

Response

No Format

POST http://ertan.emakin.com/rest/initiateByProcess

{
     "apiKey": "xxxx",
     "logonId": "user@emakin.com",
     "logonProvider": "Organization",
     "process": "e5134318-88bd-4a33-b561-4d78380734ce",
     "task": "c5350e5c-6e03-4b72-9522-49ab7f849b8a",
     "version": null,
     "data": "<pool><myField>ABC</myField></pool>",
     "culture": null
}

No Format
HTTP/1.1 200 OK { "d": "716F8FCB-98C2-4591-8C43-043D54DEAADA" }

...

Triggers an event for listeners on all processes and returns array of id number of triggered work items. When there is no listener return value is a empty array.

Required Scope

event_trigger

Parameters

Parameter Name	Description
apiKey	Caller system identifier.
logonId	User logon id
logonProvider	User logon provider.
eventName	Name of event
testMode	Trigger the test mode or not work items
inputData	Event Data in XML can be null.
culture	Culture preference. Can be null.

Example Call

Request

Response

No Format

POST http://ertan.emakin.com/rest/trigger

{
     "apiKey": "xxxx",
     "logonId": "user@emakin.com",
     "logonProvider": "Organization",
     "eventName" : "myEvent",
     "inputData": "<pool><eventParameter>ABC</eventParameter></pool>",
     "testMode": false,
     "culture": null
}

No Format
HTTP/1.1 200 OK Content-Type: application/json; charset=utf-8 { "d": ["716F8FCB-98C2-4591-8C43-043D54DEAADA"] }

...

Returns the decision result.

Required Scope

decision_execute

Parameters

Parameter Name	Description
apiKey	Caller system identifier.
logonId	User logon id
logonProvider	User logon provider.
process	Name or Id number of process
model	Name or Id number of decision model
decision	Name or Id number of decision
inputData	Decision input data. Xml or Json string.

Example Call

Request

Response

No Format

POST https://ertan.emakin.com/rest/decision

{
     "apiKey": "",
     "logonId": "user@emakin.com",
     "logonProvider": "Organization",
     "process" : "Decision",
     "model" : "dinner",
     "decision" : "Dish",
     "inputData": "<pool><Season>Fall</Season><NumberOfGuests>2</NumberOfGuests></pool>"
}

No Format
HTTP/1.1 200 OK Content-Type: application/json; charset=utf-8 Content-Length: 26 {"d":{"Dish":"Spareribs"}}

...

Versions Compared

Old Version 30

New Version 31

Key

Required Scope

Parameters

Required Scope

Parameters

Required Scope

Parameters

Required Scope

Parameters

GetWorkItemData

SelectAction

Required Scope

Parameters

Example Call

SelectAction

Parameters

Example Call

Required Scope

Parameters

Example Call

Required Scope

Parameters

Example Call

Required Scope

Parameters

Example Call