Versions Compared

Old Version 10

changes.mady.by.user Ertan Tike

Saved on

compared with

New Version 11

changes.mady.by.user Ertan Tike

Saved on

Key

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

...

Parameter NameDescription
apiKeyCaller system identifier.
logonIdUser logon id
logonProviderUser logon provider.
tagWorklist identifier. If set to null default inbox is returned.
startStart number of list. Use 0 to start from beginning.
maxLengthLimit of number of rows in list. Use -1 to get all rows.

Example Call

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
}
No Format
HTTP/1.1 200 OK
Cache-Control: private, max-age=0
Content-Type: application/json; charset=utf-8
Date: Mon, 26 Oct 2015 21:15:17 GMT
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
      }
   ]
}

GetWorklistCount

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

Parameters

Parameter NameDescription
apiKeyCaller system identifier.
logonIdUser logon id
logonProviderUser logon provider.
tagWorklist identifier. If set to null default inbox is returned.

Example Call

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
}
No Format
HTTP/1.1 200 OK
Cache-Control: private, max-age=0
Content-Type: application/json; charset=utf-8
Date: Mon, 26 Oct 2015 21:15:17 GMT
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
      }
   ]
}

...

Gets workitem information to display or complete with action.

Parameters

Parameter NameDescription
apiKeyCaller system identifier.
logonIdUser logon id
logonProviderUser logon provider.
idWork item identifier.
readOnlySet true to fetch work item read only. Default is false.

Example Call

RequestResponse
No Format
POST http://ertan.emakin2.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
Date: Mon, 26 Oct 2015 21:23:33 GMT
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
             },
             {
                 "Id": "c5350e5c-6e03-4b72-9522-49ab7f849b8a",
                 "Name": "Cancel",
                 "Color": "",
                 "BackgroundColor": "",
                 "Order": 2
             }
         ]
     }
 }

...

Gets the xml data of workitem.

Parameters

Parameter NameDescription
apiKeyCaller system identifier.
logonIdUser logon id
logonProviderUser logon provider.
idWork item identifier.

Example Call

RequestResponse
No Format
POST http://ertan.emakin2.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
Date: Mon, 26 Oct 2015 21:23:33 GMT
Content-Length: 516

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

...

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

Parameters

Parameter NameDescription
apiKeyCaller system identifier.
logonIdUser logon id
logonProviderUser logon provider.
idWork item identifier.
actionAction identifier.
dataXML data. Can be null.
commentsUser comments

Example Call

RequestResponse
No Format
POST http://ertan.emakin2.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
Date: Mon, 26 Oct 2015 21:23:33 GMT
Content-Length: 516
{
     "d": [ "716F8FCB-98C2-4591-8C43-043D54DEAADA" ]
}

...

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

Parameters

Parameter NameDescription
apiKeyCaller system identifier.
logonIdUser logon id
logonProviderUser logon provider.
processName or Id number of process
taskName or Id number of task
dataXML data. Can be null.
cultureCulture preference. Can be null.

Example Call

RequestResponse
No Format
POST http://ertan.emakin2.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",
     "data": "<pool><myField>ABC</myField></pool>"
}
No Format
HTTP/1.1 200 OK
Cache-Control: private, max-age=0
Content-Type: application/json; charset=utf-8
Date: Mon, 26 Oct 2015 21:23:33 GMT
Content-Length: 516
{
     "d": "716F8FCB-98C2-4591-8C43-043D54DEAADA"
}

...