Versions Compared

Old Version 29

changes.mady.by.user Bülent Yüksel

Saved on

compared with

New Version 30

changes.mady.by.user Ertan Tike

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Infrastructure services can be accessed from "http(s)://<mydomain>.emakin.com/rest.asmx" url. Depending on call style, service Service methods can be called in soap or rest format. If you prefer to use SOAP related WSDL document can be accessed from http://<mydomain>.emakin.com/rest.asmx?WSDL

Table of Contents

Authentication

...

Example Call

RequestResponse


No Format
POST http://ertan.emakin.com/rest
.asmx
/getToken
HTTP/1.1 Content-Type: application/json; charset=utf-8 Host: ertan.emakin.com Content-Length: 80   { "apiKey": "

 
{
     "apiKey": "xxxx",
     "logonId": "user@emakin.com",
     "logonProvider": "Organization"
}



No Format
HTTP/1.1 200 OK
Cache-Control: private,
max-age=0
Content-Type: application/json; charset=utf-8
Content-Length: 144
 
{"d":"41AA3CE3CAFB..............BF8114"}


...

RequestResponse


No Format
POST http://ertan.emakin.com/rest.asmx/getWorklist HTTP/1.1
Content-Type: application/json; charset=utf-8
Host: ertan.emakin.com
Content-Length: 91
 
{
     
 
{
     "apiKey": "xxxx",
     "logonId": "user@emakin.com",
     "logonProvider": "Organization",
     "tag": null,
     "start": 0,
     "maxLength": 30,
     "queryXml" : ""
}



No Format
HTTP/1.1 200 OK
Cache-Control: private,
max-age=0
Content-Type: application/json; charset=utf-8
Content-Length: 1245
 
{
   "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
      }
   ]
}


...

RequestResponse


No Format
POST http://ertan.emakin.com/rest.asmx/getWorklistCount HTTP/1.1
Content-Type: application/json; charset=utf-8
Host: ertan.emakin.com
Content-Length: 91
 
{
     
 
{
     "apiKey": "xxxx",
     "logonId": "user@emakin.com",
     "logonProvider": "Organization",
     "tag": null,
     "queryXml" : ""
}



No Format
HTTP/1.1 200 OK
Cache-Control: private,
max-age=0
Content-Type: application/json; charset=utf-8
Content-Length: 8
 
{
   "d":50
}


GetWorkItem

Gets workitem information to display or complete with action.

...

RequestResponse


No Format
POST http://ertan.emakin.com/rest.asmx/getWorkItem HTTP/1.1
Content-Type: application/json; charset=utf-8
Host: ertan.emakin2.com
Content-Length: 124

{
     

{
     "apiKey": "xxxx",
     "logonId": "user@emakin.com",
     "logonProvider": "Organization",
     "id": "e5134318-88bd-4a33-b561-4d78380734ce"
}



No Format
HTTP/1.1 200 OK
Cache-Control: private,
max-age=0
Content-Type: application/json; charset=utf-8
Content-Length: 516

{
     "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": ""
             }
         ]
     }
 }


...

RequestResponse


No Format
POST http://ertan.emakin.com/rest.asmx/getWorkItemData HTTP/1.1
Content-Type: application/json; charset=utf-8
Host: ertan.emakin2.com
Content-Length: 124

{
     

{
     "apiKey": "xxxx",
     "logonId": "user@emakin.com",
     "logonProvider": "Organization",
     "id": "e5134318-88bd-4a33-b561-4d78380734ce"
}



No Format
HTTP/1.1 200 OK
Cache-Control: private,
max-age=0
Content-Type: application/json; charset=utf-8
Content-Length: 516

{
     "d": {
         "Data": "<xml><poolRoot>.....</poolRoot></xml>",
         "DataRoot": "poolRoot"
     }
 }


...

RequestResponse


No Format
POST http://ertan.emakin.com/rest.asmx/selectAction HTTP/1.1
Content-Type: application/json; charset=utf-8
Host: ertan.emakin2.com
Content-Length: 124

{
     

{
     "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
Cache-Control: private,
max-age=0
Content-Type: application/json; charset=utf-8
Content-Length: 516
{
     "d": [ "716F8FCB-98C2-4591-8C43-043D54DEAADA" ]
}

...



InitiateByProcess
Initiates a new process instance with specified parameters and returns the Id number of work item.
...
RequestResponse

 No Format
POST http://ertan.emakin.com/rest.asmx/initiateByProcess
HTTP/1.1
Content-Type: application/json; charset=utf-8
Host: ertan.emakin2.com
Content-Length: 124

{
  
{
     "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
Cache-Control: private, max-age=0
Content-Type:
application/json; charset=utf-8
Content-Length: 516
{
     "d": "716F8FCB-98C2-4591-8C43-043D54DEAADA"
}

...


Trigger
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.
...
RequestResponse

 No Format
POST http://ertan.emakin.com/rest.asmx/trigger HTTP/1.1
Content-Type: application/json; charset=utf-8
Host: ertan.emakin2.com
Content-Length: 124

{
     "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
Cache-Control: private, max-age=0
Content-Type: application/json; charset=utf-8
Content-Length:
516
{
     "d": ["716F8FCB-98C2-4591-8C43-043D54DEAADA"]
}


...
RequestResponse

 No Format
POST https://ertan.emakin.com/rest.asmx/decision HTTP/1.1
Content-Type: application/json; charset=utf-8
Host: ertan.emakin.com

{
     "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
Cache-Control: private, max-age=0
Content-Type: application/json; charset=utf-8
Content-Length: 26

{"d":{"Dish":"Spareribs"}}


...