...
| Request | Response |
|---|
| No Format |
|---|
POST http://mydomain.emakin.com/rest/v1/getToken
{
"apiKey": "xxxx",
"logonId": "user@emakin.com",
"logonProvider": "Organization"
} |
|
| No Format |
|---|
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
{"d":"41AA3CE3CAFB..............BF8114"} |
|
...
| Request | Response |
|---|
| No Format |
|---|
POST http://mydomain.emakin.com/rest/v1/getTokenFromUserInfo
{
"apiKey": "xxxx",
"userInfo": {
"logonProvider": "LinkedIn",
"id": "wcomx2h3jd",
"name": "John Doe",
"email": "john.doe@noreply.com",
}
} |
|
| No Format |
|---|
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
{"d":"41AA3CE3CAFB..............BF8114"} |
|
...
| Request | Response |
|---|
| No Format |
|---|
POST http://mydomain.emakin.com/rest/v1/getWorklist
{
"apiKey": "xxxx",
"logonId": "user@emakin.com",
"logonProvider": "Organization",
"tag": null,
"start": 0,
"maxLength": 30,
"queryXml" : ""
} |
|
| 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",
"Start":"/Date(1445812020394)/",
"End":null,
"Instructions":"Please complete.",
"State":"Waiting",
"Number":12471
},
{
"Id":"796a34c6-fd2e-450e-a2af-8124ea68f8ca",
"Caption":"A new other task",
"Start":"/Date(1445512843034)/",
"End":null,
"Instructions":"Please complete.",
"State":"Waiting",
"Number":12468
}
]
} |
|
GetWorklistCount
Returns number of records in the worklist. You can use this method to specify paging parameters in the GetWorkList method.
...
| Request | Response |
|---|
| No Format |
|---|
POST http://mydomain.emakin.com/rest/v1/getWorklistCount
{
"apiKey": "xxxx",
"logonId": "user@emakin.com",
"logonProvider": "Organization",
"tag": null,
"queryXml" : ""
} |
|
| No Format |
|---|
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
{
"d":50
} |
|
GetWorkItem
Gets workitem information to display or complete with action.
...
| Request | Response |
|---|
| No Format |
|---|
POST http://mydomain.emakin.com/rest/v1/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""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": "",
": true,
"ValidationGroupConfirmationMessage": "",
}"ValidationGroup": ""
}
] ]
}
} |
|
SelectAction
Selects an action of a work item and returns an array of next work item identifiers.
...
| Request | Response |
|---|
| No Format |
|---|
POST http://mydomain.emakin.com/rest/v1/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" ]
}
|
|
InitiateByProcess
Initiates a new process instance with specified parameters and returns the Id number of work item.
...
| Request | Response |
|---|
| No Format |
|---|
POST http://mydomain.emakin.com/rest/v1/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"
}
|
|
ExecuteModule
Executes the specified module and returns result value of module function.
...
| Request | Response |
|---|
| No Format |
|---|
POST http://mydomain.emakin.com/rest/v1/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"]
}
|
|
Query
Query is xml based string that specifies the requested result. If not specified, default query is performed.
...
| Request | Response |
|---|
| No Format |
|---|
POST https://mydomain.emakin.com/rest/v1/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"}}
|
|