Kenesto Web API provides the same RESTful API that Kenesto web app and Kenesto Drive uses. You can use it for all the same operations for manipulating folders, documents and tasks. You must first be registered with Kenesto which means you must have an account in Kenesto to use the API.
Contents
Each method gets optional parameter called ud (userData) that returns same value. (To keep context or anything else) Each method returns response status – ok or failed. If it failed exception message is also returned.
Base URL: https://app.kenesto.com/Kenesto.Web.API/KTasks.svc/
1. Create Task:
Request:
CreateTask?t={token}&ud={userData}
Http Method: Post
Content-Type: application/json
Parameters:
Name | Type | Required | Description |
token | string | yes | User’s encrypted and encoded session token. |
title | string | yes | The task title. Must be 0-200 characters. |
assigneeUsername | string | no | The assignee username – email address. |
instructions | string | no | Task’s instructions. Can have up to 4000 characters. |
taskNumber | string | no | Task’s unique number. If not sent, the server will generate one. Must be 0-200 characters. |
priority | string | no | Task’s priority. Allowed values are: “critical”, “high”, “normal” and “low”. If not sent or have a forbidden value – will get the default value – “LOW”. |
userData | string | no | User Data – free text. |
Body Example
{
“title”: “My New Task”,
“assigneeUsername”: “[email protected]”,
“instructions”: “Have Fun!”,
“taskNumber”: “27345”,
“priority”: “high”
}
Response:
Type: Json Formatted String
Response Example
{
“ResponseData”: {
“TASK_ASSIGNEE”: {
“TENANT_ID”: “3”,
“FAMILY_ID”: “2514”,
“OBJECT_ID”: “be3a3293-bc0a-a046-bbcd-704bfb068a2f”,
“OWNER”: “”,
“SHARED_OBJECT_ID”: “00000000-0000-0000-0000-000000000000”,
“IS_EXT”: “False”,
“EXT_ORG_NAME”: “”,
“EXT_ORG_ID”: “00000000-0000-0000-0000-000000000000”,
“EXT_TOKEN”: “”,
“FIRST_NAME”: “Joe”,
“LAST_NAME”: “Engineer”,
“VRT_IS_ADMIN”: “True”
},
“PROCESS_NUMBER”: “10078”,
“PROCESS_NAME”: “My New Task”,
“TASK_PRIORITY”: “HIGH”,
“TASK_INSTRUCTIONS”: “Have Fun!”,
“PROCESS_INITIATOR”: “PersistentBusinessObject ID=be3a3293-bc0a-a046-bbcd-704bfb068a2f, FamilyCode=PARTICIPANT_USER, Status=Modified”,
“PROCESS_TERMINATOR”: “PersistentBusinessObject ID=be3a3293-bc0a-a046-bbcd-704bfb068a2f, FamilyCode=PARTICIPANT_USER, Status=Modified”,
“PROCESS_STATUS”: “CREATED”,
“DELETED_OBJECT_FLAG”: “False”,
“PUBLIC_ACCESS”: “false”,
“IS_SHARED”: “false”,
“IS_EXT”: “false”,
“TASK_STATUS”: “CREATED”,
“FAMILY_ID”: “100612”,
“OBJECT_ID”: “b9ad0fcc-d69e-47ab-ab50-e720752f245f”,
“SHARED_OBJECT_ID”: “b9ad0fcc-d69e-47ab-ab50-e720752f245f”,
“CREATION_DATE”: “14/08/2016 06:08:02”,
“MODIFICATION_DATE”: “14/08/2016 06:08:02”,
“ORG_USER_ID”: “ParticipantUserNtt ID=be3a3293-bc0a-a046-bbcd-704bfb068a2f, FamilyCode=PARTICIPANT_USER, Status=New”,
“CREATED_BY”: “ParticipantUserNtt ID=be3a3293-bc0a-a046-bbcd-704bfb068a2f, FamilyCode=PARTICIPANT_USER, Status=New”,
“MODIFIED_BY”: “ParticipantUserNtt ID=be3a3293-bc0a-a046-bbcd-704bfb068a2f, FamilyCode=PARTICIPANT_USER, Status=New”,
“OWNER”: “ParticipantUserNtt ID=be3a3293-bc0a-a046-bbcd-704bfb068a2f, FamilyCode=PARTICIPANT_USER, Status=New”,
“TENANT_ID”: “3”
},
“ResponseStatus”: “OK”,
“UserData”: “My User Data”
}
2. Send Task:
Request:
SendTask?t={token}&ud={userData}
Http Method: Post
Content-Type: application/json
Parameters:
Name | Type | Required | Description |
token | string | yes | User’s encrypted and encoded session token. |
taskId | Guid | yes | The task’s Id – unique identifier of the task. |
userData | string | no | User Data – free text. |
Body Example
{
“taskId”: “0defcfd6-80ac-4cd5-84d7-dd6464270b90”
}
Response:
Type: Json Formatted String
Response Example
{
“ResponseStatus”: “OK”,
“UserData”: “My User Data”
}
3. Update Task:
Request:
UpdateTask?t={token}&ud={userData}
Http Method: Post
Content-Type: application/json
Parameters:
Name | Type | Required | Description |
token | string | yes | User’s encrypted and encoded session token. |
taskId | Guid | yes | The task’s Id – unique identifier of the task. |
title | string | yes | The task title. Must be 0-200 characters. |
assigneeUsername | string | yes | The assignee username – email address. |
instructions | string | no | Task’s instructions. Can have up to 4000 characters. |
priority | string | no | Task’s priority. Allowed values are: “critical”, “high”, “normal” and “low”. If not sent or have a forbidden value – will get the default value – “LOW”. |
userData | string | no | User Data – free text. |
Body Example
{
“taskId”: “0defcfd6-80ac-4cd5-84d7-dd6464270b90”,
“title”: “My New Task”,
“assigneeUsername”: “[email protected]”,
“instructions”: “Have Fun!”,
“priority”: “high”
}
Response:
Type: Json Formatted String
Response Example
{
“ResponseData”: {
“TENANT_ID”: “3”,
“FAMILY_ID”: “100612”,
“OBJECT_ID”: “1cca57fd-5212-45f2-bc99-205ceb3b75f1”,
“CREATED_BY”: “ParticipantUserNtt ID=be3a3293-bc0a-a046-bbcd-704bfb068a2f, FamilyCode=PARTICIPANT_USER, Status=Retrieved”,
“CREATION_DATE”: “14/08/2016 06:45:32”,
“IS_IMPORTED”: “False”,
“MODIFICATION_DATE”: “14/08/2016 06:45:33”,
“MODIFIED_BY”: “ParticipantUserNtt ID=be3a3293-bc0a-a046-bbcd-704bfb068a2f, FamilyCode=PARTICIPANT_USER, Status=Retrieved”,
“OWNER”: “ParticipantUserNtt ID=be3a3293-bc0a-a046-bbcd-704bfb068a2f, FamilyCode=PARTICIPANT_USER, Status=Retrieved”,
“PUBLIC_ACCESS”: “False”,
“IS_SHARED”: “False”,
“ESC_REASSIGN_USER”: “”,
“ESC_POST_USER”: “”,
“ESC_PRE_USER”: “”,
“ESC_REASSIGN_DAYS”: “0”,
“ESC_POST_DAYS”: “0”,
“ESC_PRE_DAYS”: “0”,
“SHARED_OBJECT_ID”: “1cca57fd-5212-45f2-bc99-205ceb3b75f1”,
“PLANNED_START_DATE”: “01/01/0001 00:00:00”,
“PLANNED_DURATION”: “0”,
“PLANNED_ORDER”: “”,
“ACTUAL_START_DATE”: “01/01/0001 00:00:00”,
“ACTUAL_END_DATE”: “01/01/0001 00:00:00”,
“ACTUAL_DURATION”: “0”,
“IS_EXT”: “False”,
“EXT_TOKEN”: “”,
“EXT_ORG_NAME”: “”,
“EXT_ORG_ID”: “00000000-0000-0000-0000-000000000000”,
“PROCESS_NAME”: “My Edited Task”,
“PROCESS_DESCRIPTION”: “”,
“PARENT_PROCESS”: “”,
“PROCESS_STATUS”: “CREATED”,
“PROCESS_EXTERNAL_ACTIVITY_ID”: “00000000-0000-0000-0000-000000000000”,
“PROCESS_EXTERNAL_TOKEN”: “”,
“PROCESS_IS_EXTERNAL”: “False”,
“PROCESS_EXTERNAL_ORG”: “”,
“PROCESS_KEYWORDS”: “”,
“PROCESS_EXTERNAL_USER”: “”,
“BLOCK_PARTNER_EXTERNAL”: “False”,
“PROCESS_EXTERNAL_FAMILY_CODE”: “”,
“TASK_DUE_DATE”: “01/01/0001 00:00:00”,
“TASK_ASSIGNEE”: {
“PARTICIPANT_UNIQUE_ID”: “[email protected]”
},
“TASK_INSTRUCTIONS”: “Have Fun!”,
“TASK_PRIORITY”: “HIGH”,
“TASK_STATUS”: “CREATED”,
“PROCESS_NUMBER”: “10080”
},
“ResponseStatus”: “OK”,
“UserData”: “My User Data”
}
4. Reassign Task:
Request:
ReassignTask?t={token}&ud={userData}
Http Method: Post
Content-Type: application/json
Parameters:
Name | Type | Required | Description |
token | string | yes | User’s encrypted and encoded session token. |
taskId | Guid | yes | The task’s Id – unique identifier of the task. |
assigneeUsername | string | yes | The assignee username – email address. |
userData | string | no | User Data – free text. |
URL Example
Body Example
Response:
Type: Json Formatted String
Response Example
{
“ResponseData”: {
“TENANT_ID”: “3”,
“FAMILY_ID”: “100613”,
“OBJECT_ID”: “ecf1cd2a-c75e-46d0-afe6-d9844da70aa0”,
“CREATED_BY”: “ParticipantUserNtt ID=be3a3293-bc0a-a046-bbcd-704bfb068a2f, FamilyCode=PARTICIPANT_USER, Status=Retrieved”,
“CREATION_DATE”: “14/08/2016 06:54:09”,
“IS_IMPORTED”: “False”,
“MODIFICATION_DATE”: “14/08/2016 06:54:09”,
“MODIFIED_BY”: “ParticipantUserNtt ID=be3a3293-bc0a-a046-bbcd-704bfb068a2f, FamilyCode=PARTICIPANT_USER, Status=Retrieved”,
“OWNER”: “ParticipantUserNtt ID=be3a3293-bc0a-a046-bbcd-704bfb068a2f, FamilyCode=PARTICIPANT_USER, Status=Retrieved”,
“PROCESS_ID”: “2c2dc802-640b-446f-abc3-cc6954ef7f96”,
“ESC_REASSIGN_USER”: “”,
“ESC_POST_USER”: “”,
“ESC_PRE_USER”: “”,
“ESC_REASSIGN_DAYS”: “0”,
“ESC_POST_DAYS”: “0”,
“ESC_PRE_DAYS”: “0”,
“PLANNED_START_DATE”: “01/01/0001 00:00:00”,
“PLANNED_DURATION”: “0”,
“PLANNED_ORDER”: “”,
“ACTUAL_START_DATE”: “01/01/0001 00:00:00”,
“ACTUAL_END_DATE”: “01/01/0001 00:00:00”,
“ACTUAL_DURATION”: “0”,
“HAS_DEPENDENCIES”: “False”,
“ACTIVITY_STATUS”: “PENDING”,
“ACTIVITY_NAME”: “My New Task”,
“ACTIVITY_DESCRIPTION”: “Have Fun!”,
“ACTIVITY_RESULTS”: “”,
“ACTIVITY_SKIPPED”: “False”,
“PROCESS_FAMILY_CODE”: “TASK”,
“STEP_ID”: “00000000-0000-0000-0000-000000000000”,
“NAMING_INDEX”: “1”,
“WF_TEMPLATE_ID”: “00000000-0000-0000-0000-000000000000”,
“ACTIVITY_COLOR”: “”,
“WF_INSERTION_ID”: “00000000-0000-0000-0000-000000000000”,
“WORKFLOW_ID”: “1c0c300b-3cc3-4c91-92b3-91fad2445b31”,
“DUE_DATE”: “01/01/0001 00:00:00”,
“DUE_DATE_SETTER”: “”,
“IS_ASSIGNED”: “False”,
“ACTIVITY_READ”: “False”
},
“ResponseStatus”: “OK”,
“UserData”: “My User Data”
}
5. Terminate Task:
Request:
TerminateTask?t={token}&ud={userData}
Http Method: Post
Content-Type: application/json
Parameters:
Name | Type | Required | Description |
token | string | yes | User’s encrypted and encoded session token. |
taskId | Guid | yes | The task’s Id – unique identifier of the task. |
userData | string | no | User Data – free text. |
Body Example
{
“taskId”: “0defcfd6-80ac-4cd5-84d7-dd6464270b90
}
Response:
Type: Json Formatted String
Response Example
{
“ResponseStatus”: “OK”,
“UserData”: “My User Data”
}
6. Decline Task:
Request:
DeclineTask?t={token}&ud={userData}
Http Method: Post
Content-Type: application/json
Parameters:
Name | Type | Required | Description |
token | string | yes | User’s encrypted and encoded session token. |
taskId | Guid | yes | The task’s Id – unique identifier of the task. |
comments | string | no | Comments – free text. |
userData | string | no | User Data – free text. |
Body Example
{
“taskId”: “0defcfd6-80ac-4cd5-84d7-dd6464270b90”,
“comments”: “My important comments”
}
Response:
Type: Json Formatted String
Response Example
{
“ResponseStatus”: “OK”,
“UserData”: “My User Data”
}
7. Complete Task:
Request:
CompleteTask?t={token}&ud={userData}
Http Method: Post
Content-Type: application/json
Parameters:
Name | Type | Required | Description |
token | string | yes | User’s encrypted and encoded session token. |
taskId | Guid | yes | The task’s Id – unique identifier of the task. |
comments | string | no | Comments – free text. |
userData | string | no | User Data – free text. |
Body Example
{
“taskId”: “0defcfd6-80ac-4cd5-84d7-dd6464270b90”,
“comments”: “My important comments”
}
Response:
Type: Json Formatted String
Response Example
{
“ResponseStatus”: “OK”,
“UserData”: “My User Data”
}
8. Get Task Info:
Request:
GetTaskInfo?t={token}&tid={taskId}&ud={userData}
Http Method: Get
Parameters:
Name | Type | Required | Description |
token | string | yes | User’s encrypted and encoded session token. |
taskId | Guid | yes | The task’s Id – unique identifier of the task. |
userData | string | no | User Data – free text. |
Response:
Type: Json Formatted String
Response Example
{
“ResponseData”: {
“TENANT_ID”: “3”,
“FAMILY_ID”: “100612”,
“OBJECT_ID”: “8a2ab55a-5f5d-4d59-a173-0c3277aa0321”,
“CREATED_BY”: “ParticipantUserNtt ID=be3a3293-bc0a-a046-bbcd-704bfb068a2f, FamilyCode=PARTICIPANT_USER, Status=Retrieved”,
“CREATION_DATE”: “14/08/2016 15:25:04”,
“IS_IMPORTED”: “False”,
“MODIFIED_BY”: “ParticipantUserNtt ID=be3a3293-bc0a-a046-bbcd-704bfb068a2f, FamilyCode=PARTICIPANT_USER, Status=Retrieved”,
“OWNER”: “ParticipantUserNtt ID=be3a3293-bc0a-a046-bbcd-704bfb068a2f, FamilyCode=PARTICIPANT_USER, Status=Retrieved”,
“MODIFICATION_DATE”: “14/08/2016 15:25:04”,
“SHARED_OBJECT_ID”: “8a2ab55a-5f5d-4d59-a173-0c3277aa0321”,
“PUBLIC_ACCESS”: “False”,
“IS_EXT”: “False”,
“EXT_ORG_ID”: “00000000-0000-0000-0000-000000000000”,
“EXT_ORG_NAME”: “”,
“EXT_TOKEN”: “”,
“IS_SHARED”: “False”,
“PLANNED_START_DATE”: “01/01/0001 00:00:00”,
“PLANNED_ORDER”: “”,
“PLANNED_DURATION”: “0”,
“ACTUAL_START_DATE”: “01/01/0001 00:00:00”,
“ACTUAL_DURATION”: “0”,
“ACTUAL_END_DATE”: “01/01/0001 00:00:00”,
“ESC_REASSIGN_USER”: “”,
“ESC_POST_USER”: “”,
“ESC_PRE_DAYS”: “0”,
“ESC_REASSIGN_DAYS”: “0”,
“ESC_POST_DAYS”: “0”,
“ESC_PRE_USER”: “”,
“PROCESS_NUMBER”: “10098”,
“TASK_DUE_DATE”: “01/01/0001 00:00:00”,
“PROCESS_DESCRIPTION”: “”,
“PARENT_PROCESS”: “”,
“PROCESS_STATUS”: “CREATED”,
“PROCESS_EXTERNAL_ACTIVITY_ID”: “00000000-0000-0000-0000-000000000000”,
“PROCESS_EXTERNAL_TOKEN”: “”,
“PROCESS_IS_EXTERNAL”: “False”,
“PROCESS_EXTERNAL_ORG”: “”,
“PROCESS_KEYWORDS”: “”,
“PROCESS_EXTERNAL_USER”: “”,
“BLOCK_PARTNER_EXTERNAL”: “False”,
“PROCESS_EXTERNAL_FAMILY_CODE”: “”,
“PROCESS_NAME”: “My New Task”,
“TASK_ASSIGNEE”: {
“TENANT_ID”: “3”,
“FAMILY_ID”: “2514”,
“OBJECT_ID”: “be3a3293-bc0a-a046-bbcd-704bfb068a2f”,
“USER_ID”: “00000000-0000-0000-0000-000000000000”,
“CREATED_BY”: “”,
“CREATION_DATE”: “01/01/0001 00:00:00”,
“IS_IMPORTED”: “False”,
“MODIFIED_BY”: “”,
“OWNER”: “”,
“MODIFICATION_DATE”: “01/01/0001 00:00:00”,
“SHARED_OBJECT_ID”: “00000000-0000-0000-0000-000000000000”,
“PUBLIC_ACCESS”: “False”,
“IS_EXT”: “False”,
“EXT_ORG_ID”: “00000000-0000-0000-0000-000000000000”,
“EXT_ORG_NAME”: “”,
“EXT_TOKEN”: “”,
“IS_SHARED”: “False”,
“FIRST_NAME”: “Joe”,
“LAST_NAME”: “Engineer”,
“GLOBAL_ID”: “00000000-0000-0000-0000-000000000000”,
“INTRODUCTION_SENT”: “False”,
“THUMBNAIL_PATH”: “”,
“PARTICIPANT_UNIQUE_ID”: “[email protected]”,
“USER_NAME”: “”,
“JOB_TITLE”: “”,
“PHONE”: “03-95054545”,
“MOBILE”: “”,
“USER_EMAIL”: “”
},
“TASK_INSTRUCTIONS”: “Have Fun!”,
“TASK_STATUS”: “CREATED”,
“TASK_PRIORITY”: “HIGH”
},
“ResponseStatus”: “OK”,
“UserData”: “My User Data”
}
9. Get My Active Tasks:
Request:
GetMyActiveTasks?t={token}&ps={pageSize}&pn={pageNumber}&ud={userData}
Http Method: Get
Parameters:
Name | Type | Required | Description |
token | string | yes | User’s encrypted and encoded session token. |
pageSize | int | no | Page size – the max number of results that will return. Allowed values: 25, 100 and 200. If not sent – default value is 25. If forbidden value was sent – Throwing an exception. |
pageNumber | int | no | Page number – the results page we want. Total results/Page size = number of pages. If requested page number is bigger than last page number – returning all results. If not sent – default value is 1. |
userData | string | no | User Data – free text. |
Response:
Type: Json Formatted String
Response Example
{
“ResponseData”: {
“RESULTS”: {
“Object0”: {
“TENANT_ID”: “3”,
“FAMILY_ID”: “100612”,
“OBJECT_ID”: “2c2dc802-640b-446f-abc3-cc6954ef7f96”,
“PROCESS_NAME”: “My New Task1”,
“PROCESS_NUMBER”: “10081”,
“TASK_PRIORITY”: “HIGH”,
“TASK_STATUS”: “CREATED”,
“TASK_ASSIGNEE”: {
“TENANT_ID”: “3”,
“FAMILY_ID”: “100148”,
“OBJECT_ID”: “2e6aa4c1-2eaa-4824-bd85-95f28a87bc19”,
“CREATED_BY”: “ParticipantUserNtt ID=be3a3293-bc0a-a046-bbcd-704bfb068a2f, FamilyCode=PARTICIPANT_USER, Status=Retrieved”,
“CREATION_DATE”: “09/08/2016 09:16:33”,
“IS_IMPORTED”: “False”,
“MODIFICATION_DATE”: “09/08/2016 09:16:33”,
“MODIFIED_BY”: “ParticipantUserNtt ID=be3a3293-bc0a-a046-bbcd-704bfb068a2f, FamilyCode=PARTICIPANT_USER, Status=Retrieved”,
“OWNER”: “ParticipantUserNtt ID=be3a3293-bc0a-a046-bbcd-704bfb068a2f, FamilyCode=PARTICIPANT_USER, Status=Retrieved”,
“PUBLIC_ACCESS”: “False”,
“SHARED_OBJECT_ID”: “2e6aa4c1-2eaa-4824-bd85-95f28a87bc19”,
“FIRST_NAME”: “”,
“LAST_NAME”: “”,
“IS_EXT”: “False”,
“EXT_TOKEN”: “”,
“EXT_ORG_NAME”: “”,
“EXT_ORG_ID”: “00000000-0000-0000-0000-000000000000”,
“IS_SHARED”: “False”,
“PARTICIPANT_UNIQUE_ID”: “[email protected]”,
“THUMBNAIL_PATH”: “”,
“GLOBAL_ID”: “00000000-0000-0000-0000-000000000000”,
“INTRODUCTION_SENT”: “False”,
“PARTNER_ORGANIZATION”: “”,
“ORGANIZATION_ID”: “00000000-0000-0000-0000-000000000000”
},
“TASK_INSTRUCTIONS”: “Have Fun!”,
“PUBLIC_ACCESS”: “False”,
“IS_SHARED”: “False”,
“OWNER”: “ParticipantUserNtt ID=be3a3293-bc0a-a046-bbcd-704bfb068a2f, FamilyCode=PARTICIPANT_USER, Status=Retrieved”,
“MODIFICATION_DATE”: “14/08/2016 06:54:10”,
“SHARED_OBJECT_ID”: “2c2dc802-640b-446f-abc3-cc6954ef7f96”,
“IS_EXT”: “False”,
“EXT_ORG_NAME”: “”,
“EXT_ORG_ID”: “00000000-0000-0000-0000-000000000000”,
“EXT_TOKEN”: “”
},
.
.
.
“Object24”: {
“TENANT_ID”: “3”,
“FAMILY_ID”: “100612”,
“OBJECT_ID”: “0dea75b0-be7c-49c9-896c-0a6dde923285”,
“PROCESS_NAME”: ” My New Task25″,
“PROCESS_NUMBER”: “10051”,
“TASK_PRIORITY”: “NORMAL”,
“TASK_STATUS”: “ACTIVE”,
“TASK_ASSIGNEE”: {
“TENANT_ID”: “3”,
“FAMILY_ID”: “2514”,
“OBJECT_ID”: “be3a3293-bc0a-a046-bbcd-704bfb068a2f”,
“USER_ID”: “00000000-0000-0000-0000-000000000000”,
“CREATED_BY”: “”,
“CREATION_DATE”: “01/01/0001 00:00:00”,
“IS_IMPORTED”: “False”,
“MODIFICATION_DATE”: “01/01/0001 00:00:00”,
“MODIFIED_BY”: “”,
“OWNER”: “”,
“PUBLIC_ACCESS”: “False”,
“SHARED_OBJECT_ID”: “00000000-0000-0000-0000-000000000000”,
“FIRST_NAME”: “Joe”,
“LAST_NAME”: “Engineer”,
“IS_EXT”: “False”,
“EXT_TOKEN”: “”,
“EXT_ORG_NAME”: “”,
“EXT_ORG_ID”: “00000000-0000-0000-0000-000000000000”,
“IS_SHARED”: “False”,
“PARTICIPANT_UNIQUE_ID”: “[email protected]”,
“THUMBNAIL_PATH”: “”,
“GLOBAL_ID”: “00000000-0000-0000-0000-000000000000”,
“INTRODUCTION_SENT”: “False”,
“USER_NAME”: “”,
“USER_EMAIL”: “”,
“PHONE”: “03-95054545”,
“MOBILE”: “”,
“JOB_TITLE”: “”
},
“TASK_INSTRUCTIONS”: “Have Fun!”,
“PUBLIC_ACCESS”: “False”,
“IS_SHARED”: “False”,
“OWNER”: “ParticipantUserNtt ID=be3a3293-bc0a-a046-bbcd-704bfb068a2f, FamilyCode=PARTICIPANT_USER, Status=Retrieved”,
“MODIFICATION_DATE”: “10/08/2016 07:33:26”,
“SHARED_OBJECT_ID”: “0dea75b0-be7c-49c9-896c-0a6dde923285”,
“IS_EXT”: “False”,
“EXT_ORG_NAME”: “”,
“EXT_ORG_ID”: “00000000-0000-0000-0000-000000000000”,
“EXT_TOKEN”: “”
}
},
“INFO”: {
“TOTAL”: 75
}
},
“ResponseStatus”: “OK”,
“UserData”: “My User Data”
}
10. Get My Completed Tasks:
Request:
GetMyCompletedTasks?t={token}&ps={pageSize}&pn={pageNumber}&ud={userData}
Http Method: Get
Parameters:
Name | Type | Required | Description |
token | string | yes | User’s encrypted and encoded session token. |
pageSize | int | no | Page size – the max number of results that will return. Allowed values: 25, 100 and 200. If not sent – default value is 25. If forbidden value was sent – Throwing an exception. |
pageNumber | int | no | Page number – the results page we want. Total results/Page size = number of pages. If requested page number is bigger than last page number – returning all results. If not sent – default value is 1. |
userData | string | no | User Data – free text. |
Response:
Type: Json Formatted String
Response Example
{
“ResponseData”: {
“RESULTS”: {
“Object0”: {
“TENANT_ID”: “3”,
“FAMILY_ID”: “100612”,
“OBJECT_ID”: “141d80a6-d413-4f3c-8112-c7889fa5cf4b”,
“PROCESS_NAME”: “My New Task1”,
“PROCESS_NUMBER”: “10082”,
“TASK_PRIORITY”: “HIGH”,
“TASK_STATUS”: “CANCELED”,
“TASK_ASSIGNEE”: {
“TENANT_ID”: “3”,
“FAMILY_ID”: “2514”,
“OBJECT_ID”: “be3a3293-bc0a-a046-bbcd-704bfb068a2f”,
“USER_ID”: “00000000-0000-0000-0000-000000000000”,
“CREATED_BY”: “”,
“CREATION_DATE”: “01/01/0001 00:00:00”,
“IS_IMPORTED”: “False”,
“MODIFICATION_DATE”: “01/01/0001 00:00:00”,
“MODIFIED_BY”: “”,
“OWNER”: “”,
“PUBLIC_ACCESS”: “False”,
“SHARED_OBJECT_ID”: “00000000-0000-0000-0000-000000000000”,
“FIRST_NAME”: “Joe”,
“LAST_NAME”: “Engineer”,
“IS_EXT”: “False”,
“EXT_TOKEN”: “”,
“EXT_ORG_NAME”: “”,
“EXT_ORG_ID”: “00000000-0000-0000-0000-000000000000”,
“IS_SHARED”: “False”,
“PARTICIPANT_UNIQUE_ID”: “[email protected]”,
“THUMBNAIL_PATH”: “”,
“GLOBAL_ID”: “00000000-0000-0000-0000-000000000000”,
“INTRODUCTION_SENT”: “False”,
“USER_NAME”: “”,
“USER_EMAIL”: “”,
“PHONE”: “03-95054545”,
“MOBILE”: “”,
“JOB_TITLE”: “”
},
“TASK_INSTRUCTIONS”: “Have Fun!”,
“PUBLIC_ACCESS”: “False”,
“IS_SHARED”: “False”,
“OWNER”: “ParticipantUserNtt ID=be3a3293-bc0a-a046-bbcd-704bfb068a2f, FamilyCode=PARTICIPANT_USER, Status=Retrieved”,
“MODIFICATION_DATE”: “14/08/2016 07:01:49”,
“REAL_ASSIGNEE”: {
“TENANT_ID”: “3”,
“FAMILY_ID”: “2514”,
“OBJECT_ID”: “be3a3293-bc0a-a046-bbcd-704bfb068a2f”,
“USER_ID”: “00000000-0000-0000-0000-000000000000”,
“CREATED_BY”: “”,
“CREATION_DATE”: “01/01/0001 00:00:00”,
“IS_IMPORTED”: “False”,
“MODIFICATION_DATE”: “01/01/0001 00:00:00”,
“MODIFIED_BY”: “”,
“OWNER”: “”,
“PUBLIC_ACCESS”: “False”,
“SHARED_OBJECT_ID”: “00000000-0000-0000-0000-000000000000”,
“FIRST_NAME”: “Joe”,
“LAST_NAME”: “Engineer”,
“IS_EXT”: “False”,
“EXT_TOKEN”: “”,
“EXT_ORG_NAME”: “”,
“EXT_ORG_ID”: “00000000-0000-0000-0000-000000000000”,
“IS_SHARED”: “False”,
“PARTICIPANT_UNIQUE_ID”: “[email protected]”,
“THUMBNAIL_PATH”: “”,
“GLOBAL_ID”: “00000000-0000-0000-0000-000000000000”,
“INTRODUCTION_SENT”: “False”,
“USER_NAME”: “”,
“USER_EMAIL”: “”,
“PHONE”: “03-95054545”,
“MOBILE”: “”,
“JOB_TITLE”: “”
},
“SHARED_OBJECT_ID”: “141d80a6-d413-4f3c-8112-c7889fa5cf4b”,
“IS_EXT”: “False”,
“EXT_ORG_NAME”: “”,
“EXT_ORG_ID”: “00000000-0000-0000-0000-000000000000”,
“EXT_TOKEN”: “”
},
.
.
.
“Object3”: {
“TENANT_ID”: “3”,
“FAMILY_ID”: “100612”,
“OBJECT_ID”: “5c21bbf2-769a-46c0-9df5-dd2d0287dca1”,
“PROCESS_NAME”: “My New Task4”,
“PROCESS_NUMBER”: “10050”,
“TASK_PRIORITY”: “HIGH”,
“TASK_STATUS”: “CANCELED”,
“TASK_ASSIGNEE”: {
“TENANT_ID”: “3”,
“FAMILY_ID”: “2514”,
“OBJECT_ID”: “be3a3293-bc0a-a046-bbcd-704bfb068a2f”,
“USER_ID”: “00000000-0000-0000-0000-000000000000”,
“CREATED_BY”: “”,
“CREATION_DATE”: “01/01/0001 00:00:00”,
“IS_IMPORTED”: “False”,
“MODIFICATION_DATE”: “01/01/0001 00:00:00”,
“MODIFIED_BY”: “”,
“OWNER”: “”,
“PUBLIC_ACCESS”: “False”,
“SHARED_OBJECT_ID”: “00000000-0000-0000-0000-000000000000”,
“FIRST_NAME”: “Joe”,
“LAST_NAME”: “Engineer”,
“IS_EXT”: “False”,
“EXT_TOKEN”: “”,
“EXT_ORG_NAME”: “”,
“EXT_ORG_ID”: “00000000-0000-0000-0000-000000000000”,
“IS_SHARED”: “False”,
“PARTICIPANT_UNIQUE_ID”: “[email protected]”,
“THUMBNAIL_PATH”: “”,
“GLOBAL_ID”: “00000000-0000-0000-0000-000000000000”,
“INTRODUCTION_SENT”: “False”,
“USER_NAME”: “”,
“USER_EMAIL”: “”,
“PHONE”: “03-95054545”,
“MOBILE”: “”,
“JOB_TITLE”: “”
},
“TASK_INSTRUCTIONS”: “Have Fun!”,
“PUBLIC_ACCESS”: “False”,
“IS_SHARED”: “False”,
“OWNER”: “ParticipantUserNtt ID=be3a3293-bc0a-a046-bbcd-704bfb068a2f, FamilyCode=PARTICIPANT_USER, Status=Retrieved”,
“MODIFICATION_DATE”: “10/08/2016 06:31:41”,
“REAL_ASSIGNEE”: {
“TENANT_ID”: “3”,
“FAMILY_ID”: “2514”,
“OBJECT_ID”: “be3a3293-bc0a-a046-bbcd-704bfb068a2f”,
“USER_ID”: “00000000-0000-0000-0000-000000000000”,
“CREATED_BY”: “”,
“CREATION_DATE”: “01/01/0001 00:00:00”,
“IS_IMPORTED”: “False”,
“MODIFICATION_DATE”: “01/01/0001 00:00:00”,
“MODIFIED_BY”: “”,
“OWNER”: “”,
“PUBLIC_ACCESS”: “False”,
“SHARED_OBJECT_ID”: “00000000-0000-0000-0000-000000000000”,
“FIRST_NAME”: “Joe”,
“LAST_NAME”: “Engineer”,
“IS_EXT”: “False”,
“EXT_TOKEN”: “”,
“EXT_ORG_NAME”: “”,
“EXT_ORG_ID”: “00000000-0000-0000-0000-000000000000”,
“IS_SHARED”: “False”,
“PARTICIPANT_UNIQUE_ID”: “[email protected]”,
“THUMBNAIL_PATH”: “”,
“GLOBAL_ID”: “00000000-0000-0000-0000-000000000000”,
“INTRODUCTION_SENT”: “False”,
“USER_NAME”: “”,
“USER_EMAIL”: “”,
“PHONE”: “03-95054545”,
“MOBILE”: “”,
“JOB_TITLE”: “”
},
“SHARED_OBJECT_ID”: “5c21bbf2-769a-46c0-9df5-dd2d0287dca1”,
“IS_EXT”: “False”,
“EXT_ORG_NAME”: “”,
“EXT_ORG_ID”: “00000000-0000-0000-0000-000000000000”,
“EXT_TOKEN”: “”
}
},
“INFO”: {
“TOTAL”: 4
}
},
“ResponseStatus”: “OK”,
“UserData”: “My User Data”
}
11. Get Tasks Assigned To Me:
Request:
GetTasksAssignedToMe?t={token}&ps={pageSize}&pn={pageNumber}&ud={userData}
Http Method: Get
Parameters:
Name | Type | Required | Description |
token | string | yes | User’s encrypted and encoded session token. |
pageSize | int | no | Page size – the max number of results that will return. Allowed values: 25, 100 and 200. If not sent – default value is 25. If forbidden value was sent – Throwing an exception. |
pageNumber | int | no | Page number – the results page we want. Total results/Page size = number of pages. If requested page number is bigger than last page number – returning all results. If not sent – default value is 1. |
userData | string | no | User Data – free text. |
Response:
Type: Json Formatted String
Response Example
{
“ResponseData”: {
“RESULTS”: {
“Object0”: {
“TENANT_ID”: “3”,
“FAMILY_ID”: “100612”,
“OBJECT_ID”: “0defcfd6-80ac-4cd5-84d7-dd6464270b90”,
“PROCESS_NAME”: “My New Task1”,
“PROCESS_NUMBER”: “10079”,
“TASK_PRIORITY”: “HIGH”,
“TASK_STATUS”: “ACTIVE”,
“TASK_ASSIGNEE”: {
“TENANT_ID”: “3”,
“FAMILY_ID”: “2514”,
“OBJECT_ID”: “be3a3293-bc0a-a046-bbcd-704bfb068a2f”,
“USER_ID”: “00000000-0000-0000-0000-000000000000”,
“CREATED_BY”: “”,
“CREATION_DATE”: “01/01/0001 00:00:00”,
“IS_IMPORTED”: “False”,
“MODIFICATION_DATE”: “01/01/0001 00:00:00”,
“MODIFIED_BY”: “”,
“OWNER”: “”,
“PUBLIC_ACCESS”: “False”,
“SHARED_OBJECT_ID”: “00000000-0000-0000-0000-000000000000”,
“FIRST_NAME”: “Joe”,
“LAST_NAME”: “Engineer”,
“IS_EXT”: “False”,
“EXT_TOKEN”: “”,
“EXT_ORG_NAME”: “”,
“EXT_ORG_ID”: “00000000-0000-0000-0000-000000000000”,
“IS_SHARED”: “False”,
“PARTICIPANT_UNIQUE_ID”: “[email protected]”,
“THUMBNAIL_PATH”: “”,
“GLOBAL_ID”: “00000000-0000-0000-0000-000000000000”,
“INTRODUCTION_SENT”: “False”,
“USER_NAME”: “”,
“USER_EMAIL”: “”,
“PHONE”: “03-95054545”,
“MOBILE”: “”,
“JOB_TITLE”: “”
},
“TASK_INSTRUCTIONS”: “Have Fun!”,
“PUBLIC_ACCESS”: “False”,
“IS_SHARED”: “False”,
“OWNER”: “ParticipantUserNtt ID=be3a3293-bc0a-a046-bbcd-704bfb068a2f, FamilyCode=PARTICIPANT_USER, Status=Retrieved”,
“MODIFICATION_DATE”: “14/08/2016 06:34:35”,
“SHARED_OBJECT_ID”: “0defcfd6-80ac-4cd5-84d7-dd6464270b90”,
“IS_EXT”: “False”,
“EXT_ORG_NAME”: “”,
“EXT_ORG_ID”: “00000000-0000-0000-0000-000000000000”,
“EXT_TOKEN”: “”
},
.
.
.
“Object7”: {
“TENANT_ID”: “3”,
“FAMILY_ID”: “100612”,
“OBJECT_ID”: “0c306e0f-ef0f-4b44-a06f-4ac72b673f72”,
“PROCESS_NAME”: “My New Task8”,
“PROCESS_NUMBER”: “10019”,
“TASK_PRIORITY”: “HIGH”,
“TASK_STATUS”: “ACTIVE”,
“TASK_ASSIGNEE”: {
“TENANT_ID”: “3”,
“FAMILY_ID”: “2514”,
“OBJECT_ID”: “be3a3293-bc0a-a046-bbcd-704bfb068a2f”,
“USER_ID”: “00000000-0000-0000-0000-000000000000”,
“CREATED_BY”: “”,
“CREATION_DATE”: “01/01/0001 00:00:00”,
“IS_IMPORTED”: “False”,
“MODIFICATION_DATE”: “01/01/0001 00:00:00”,
“MODIFIED_BY”: “”,
“OWNER”: “”,
“PUBLIC_ACCESS”: “False”,
“SHARED_OBJECT_ID”: “00000000-0000-0000-0000-000000000000”,
“FIRST_NAME”: “Joe”,
“LAST_NAME”: “Engineer”,
“IS_EXT”: “False”,
“EXT_TOKEN”: “”,
“EXT_ORG_NAME”: “”,
“EXT_ORG_ID”: “00000000-0000-0000-0000-000000000000”,
“IS_SHARED”: “False”,
“PARTICIPANT_UNIQUE_ID”: “[email protected]”,
“THUMBNAIL_PATH”: “”,
“GLOBAL_ID”: “00000000-0000-0000-0000-000000000000”,
“INTRODUCTION_SENT”: “False”,
“USER_NAME”: “”,
“USER_EMAIL”: “”,
“PHONE”: “03-95054545”,
“MOBILE”: “”,
“JOB_TITLE”: “”
},
“TASK_INSTRUCTIONS”: “Have Fun!”,
“PUBLIC_ACCESS”: “False”,
“IS_SHARED”: “False”,
“OWNER”: “ParticipantUserNtt ID=be3a3293-bc0a-a046-bbcd-704bfb068a2f, FamilyCode=PARTICIPANT_USER, Status=Retrieved”,
“MODIFICATION_DATE”: “09/08/2016 10:21:16”,
“SHARED_OBJECT_ID”: “0c306e0f-ef0f-4b44-a06f-4ac72b673f72”,
“IS_EXT”: “False”,
“EXT_ORG_NAME”: “”,
“EXT_ORG_ID”: “00000000-0000-0000-0000-000000000000”,
“EXT_TOKEN”: “”
}
},
“INFO”: {
“TOTAL”: 8
}
},
“ResponseStatus”: “OK”,
“UserData”: “My User Data”
}
12. Get Tasks I Own:
Request:
GetTasksIOwn?t={token}&ps={pageSize}&pn={pageNumber}&ud={userData}
Http Method: Get
Parameters:
Name | Type | Required | Description |
token | string | yes | User’s encrypted and encoded session token. |
pageSize | int | no | Page size – the max number of results that will return. Allowed values: 25, 100 and 200. If not sent – default value is 25. If forbidden value was sent – Throwing an exception. |
pageNumber | int | no | Page number – the results page we want. Total results/Page size = number of pages. If requested page number is bigger than last page number – returning all results. If not sent – default value is 1. |
userData | string | no | User Data – free text. |
Response:
Type: Json Formatted String
Response Example
{
“ResponseData”: {
“RESULTS”: {
“Object0”: {
“TENANT_ID”: “3”,
“FAMILY_ID”: “100612”,
“OBJECT_ID”: “2c2dc802-640b-446f-abc3-cc6954ef7f96”,
“PROCESS_NAME”: “My New Task1”,
“PROCESS_NUMBER”: “10081”,
“TASK_PRIORITY”: “HIGH”,
“TASK_STATUS”: “CREATED”,
“TASK_ASSIGNEE”: {
“TENANT_ID”: “3”,
“FAMILY_ID”: “100148”,
“OBJECT_ID”: “2e6aa4c1-2eaa-4824-bd85-95f28a87bc19”,
“CREATED_BY”: “ParticipantUserNtt ID=be3a3293-bc0a-a046-bbcd-704bfb068a2f, FamilyCode=PARTICIPANT_USER, Status=Retrieved”,
“CREATION_DATE”: “09/08/2016 09:16:33”,
“IS_IMPORTED”: “False”,
“MODIFICATION_DATE”: “09/08/2016 09:16:33”,
“MODIFIED_BY”: “ParticipantUserNtt ID=be3a3293-bc0a-a046-bbcd-704bfb068a2f, FamilyCode=PARTICIPANT_USER, Status=Retrieved”,
“OWNER”: “ParticipantUserNtt ID=be3a3293-bc0a-a046-bbcd-704bfb068a2f, FamilyCode=PARTICIPANT_USER, Status=Retrieved”,
“PUBLIC_ACCESS”: “False”,
“SHARED_OBJECT_ID”: “2e6aa4c1-2eaa-4824-bd85-95f28a87bc19”,
“FIRST_NAME”: “”,
“LAST_NAME”: “”,
“IS_EXT”: “False”,
“EXT_TOKEN”: “”,
“EXT_ORG_NAME”: “”,
“EXT_ORG_ID”: “00000000-0000-0000-0000-000000000000”,
“IS_SHARED”: “False”,
“PARTICIPANT_UNIQUE_ID”: “[email protected]”,
“THUMBNAIL_PATH”: “”,
“GLOBAL_ID”: “00000000-0000-0000-0000-000000000000”,
“INTRODUCTION_SENT”: “False”,
“PARTNER_ORGANIZATION”: “”,
“ORGANIZATION_ID”: “00000000-0000-0000-0000-000000000000”
},
“TASK_INSTRUCTIONS”: “Have Fun!”,
“PUBLIC_ACCESS”: “False”,
“IS_SHARED”: “False”,
“OWNER”: “ParticipantUserNtt ID=be3a3293-bc0a-a046-bbcd-704bfb068a2f, FamilyCode=PARTICIPANT_USER, Status=Retrieved”,
“MODIFICATION_DATE”: “14/08/2016 06:54:10”,
“SHARED_OBJECT_ID”: “2c2dc802-640b-446f-abc3-cc6954ef7f96”,
“IS_EXT”: “False”,
“EXT_ORG_NAME”: “”,
“EXT_ORG_ID”: “00000000-0000-0000-0000-000000000000”,
“EXT_TOKEN”: “”
},
.
.
.
“Object24”: {
“TENANT_ID”: “3”,
“FAMILY_ID”: “100612”,
“OBJECT_ID”: “0dea75b0-be7c-49c9-896c-0a6dde923285”,
“PROCESS_NAME”: “My New Task25”,
“PROCESS_NUMBER”: “10051”,
“TASK_PRIORITY”: “NORMAL”,
“TASK_STATUS”: “ACTIVE”,
“TASK_ASSIGNEE”: {
“TENANT_ID”: “3”,
“FAMILY_ID”: “2514”,
“OBJECT_ID”: “be3a3293-bc0a-a046-bbcd-704bfb068a2f”,
“USER_ID”: “00000000-0000-0000-0000-000000000000”,
“CREATED_BY”: “”,
“CREATION_DATE”: “01/01/0001 00:00:00”,
“IS_IMPORTED”: “False”,
“MODIFICATION_DATE”: “01/01/0001 00:00:00”,
“MODIFIED_BY”: “”,
“OWNER”: “”,
“PUBLIC_ACCESS”: “False”,
“SHARED_OBJECT_ID”: “00000000-0000-0000-0000-000000000000”,
“FIRST_NAME”: “Joe”,
“LAST_NAME”: “Engineer”,
“IS_EXT”: “False”,
“EXT_TOKEN”: “”,
“EXT_ORG_NAME”: “”,
“EXT_ORG_ID”: “00000000-0000-0000-0000-000000000000”,
“IS_SHARED”: “False”,
“PARTICIPANT_UNIQUE_ID”: “[email protected]”,
“THUMBNAIL_PATH”: “”,
“GLOBAL_ID”: “00000000-0000-0000-0000-000000000000”,
“INTRODUCTION_SENT”: “False”,
“USER_NAME”: “”,
“USER_EMAIL”: “”,
“PHONE”: “03-95054545”,
“MOBILE”: “”,
“JOB_TITLE”: “”
},
“TASK_INSTRUCTIONS”: “Have Fun!”,
“PUBLIC_ACCESS”: “False”,
“IS_SHARED”: “False”,
“OWNER”: “ParticipantUserNtt ID=be3a3293-bc0a-a046-bbcd-704bfb068a2f, FamilyCode=PARTICIPANT_USER, Status=Retrieved”,
“MODIFICATION_DATE”: “10/08/2016 07:33:26”,
“SHARED_OBJECT_ID”: “0dea75b0-be7c-49c9-896c-0a6dde923285”,
“IS_EXT”: “False”,
“EXT_ORG_NAME”: “”,
“EXT_ORG_ID”: “00000000-0000-0000-0000-000000000000”,
“EXT_TOKEN”: “”
}
},
“INFO”: {
“TOTAL”: 75
}
},
“ResponseStatus”: “OK”,
“UserData”: “My user Data”
}