Please rate how useful you found this document:
Process Permission Endpoints
Contents: [hide]
- Process Permission Endpoints
- Get Process Permissions List:
GET project/{prj_uid}/process-permissions - Get Process Permission:
GET project/{prj_uid}/process-permission/{op_uid} - Create Process Permission:
POST project/{prj_uid}/process-permission - Update Process Permission:
PUT project/{prj_uid}/process-permission/{op_uid} - Delete Process Permission:
DELETE project/{prj_uid}/process-permission/{op_uid}
Process Permission resources:
| Name | Description | Type | Value |
|---|---|---|---|
| op_uid | Process permission UID | String | "h3kj231..." (String) |
| usr_uid | User or group that will get the permission (value depends on "Op_user_relation") | String | "h3kj231..." (user or group UID) |
| op_user_relation | Value to determine if the permission will be set to a user or a group (1 =user, 2 = group) | String | "1" or "2" (unique values) |
| op_case_status | The case status that will get the permission | String | "ALL" or "DRAFT" or "TO_DO" or "PAUSED" or "COMPLETED" or (unique values) |
| op_participate | Enables the permission for a user who participated in the case or a user who didn't (0 = did not participate, 1 = participated) | String | "0" or "1" (unique values) |
| opt_obj_type | Value for the type of object of the permission | String | "ANY" or "DYNAFORM" OR "INPUT" "OUTPUT" "CASES_NOTES" "MSGS_HISTORY" (unique values) |
| op_action | Type of action of the assigned permission | String | "BLOCK" or "VIEW" or "DELETE" (unique values) |
| tas_uid | Value of the objective task UID of the permission. | String | "h3kj231..." (task UID) |
| op_task_source | Value of the origin task UID of the permission. | String | "h3kj231..." (task UID) |
| dynaforms | Value of the dynaform UID of the permission (Only takes this field into account when the value of "op_obj_type" is "DYNAFORM" | String | "h3kj231..." (Dynaform UID) |
| inputs | Value of the input permission UID (Only takes this field into account when the value of "op_obj_type" is "INPUT") | Integer | "h3kj321..." (Input UID) |
| outputs | Value of the output permission UID (Only takes this field in account when the "op_obj_type" value is "OUTPUT") | Integer | "h3kj321..." (Output UID) |
Get Process Permissions List: GET project/{prj_uid}/process-permissions
Gets a list of the Process Permissions in a project.
GET /api/1.0/{workspace}/project/{prj_uid}/process-permissions
Parameters:
-
Name Type Description workspace String Workspace name prj_uid String Project UID
Result:
-
Type Description array Returns an array containing the process permissions objects.
Example:
Response
200 (OK)
[
{
"op_uid": "48370777252dec9d6cbf645068319750",
"pro_uid": "251815090529619a99a2bf4013294414",
"tas_uid": "",
"usr_uid": "35762872152cda4323207c6035916735",
"op_user_relation": "2",
"op_task_source": "",
"op_participate": "1",
"op_obj_type": "any",
"op_obj_uid": "",
"op_action": "view",
"op_case_status": "all",
"task_target": "all tasks",
"group_user": "accounting",
"task_source": "all tasks",
"object_type": "all",
"object": "all",
"participated": "yes",
"action": "view"
},
{
"op_uid": "69838576352dec9fa91c316052065643",
"pro_uid": "251815090529619a99a2bf4013294414",
"tas_uid": "95655319552a5c790b69a04054667879",
"usr_uid": "20972963752cda4006d1676029328277",
"op_user_relation": "1",
"op_task_source": "95655319552a5c790b69a04054667879",
"op_participate": "0",
"op_obj_type": "dynaform",
"op_obj_uid": "41320210152964e39d34c91015371856",
"op_action": "block",
"op_case_status": "draft",
"task_target": "task 2",
"group_user": "adam corey (adam)",
"task_source": "task 2",
"object_type": "dynaform",
"object": "eede",
"participated": "no",
"action": "block"
}
]
[
{
"op_uid": "48370777252dec9d6cbf645068319750",
"pro_uid": "251815090529619a99a2bf4013294414",
"tas_uid": "",
"usr_uid": "35762872152cda4323207c6035916735",
"op_user_relation": "2",
"op_task_source": "",
"op_participate": "1",
"op_obj_type": "any",
"op_obj_uid": "",
"op_action": "view",
"op_case_status": "all",
"task_target": "all tasks",
"group_user": "accounting",
"task_source": "all tasks",
"object_type": "all",
"object": "all",
"participated": "yes",
"action": "view"
},
{
"op_uid": "69838576352dec9fa91c316052065643",
"pro_uid": "251815090529619a99a2bf4013294414",
"tas_uid": "95655319552a5c790b69a04054667879",
"usr_uid": "20972963752cda4006d1676029328277",
"op_user_relation": "1",
"op_task_source": "95655319552a5c790b69a04054667879",
"op_participate": "0",
"op_obj_type": "dynaform",
"op_obj_uid": "41320210152964e39d34c91015371856",
"op_action": "block",
"op_case_status": "draft",
"task_target": "task 2",
"group_user": "adam corey (adam)",
"task_source": "task 2",
"object_type": "dynaform",
"object": "eede",
"participated": "no",
"action": "block"
}
]
Get Process Permission: GET project/{prj_uid}/process-permission/{op_uid}
Gets a specified Process Permission.
GET /api/1.0/{workspace}/project/{prj_uid}/process-permission/{op_uid}
Parameters:
-
Name Type Description workspace String Workspace name prj_uid String Project UID op_uid String Process Permission UID
Result:
-
Type Description object Returns an object containing the process permission.
Example:
Response
200 (OK)
[
"op_uid": "69838576352dec9fa91c316052065643",
"pro_uid": "251815090529619a99a2bf4013294414",
"tas_uid": "95655319552a5c790b69a04054667879",
"usr_uid": "20972963752cda4006d1676029328277",
"op_user_relation": "1",
"op_task_source": "95655319552a5c790b69a04054667879",
"op_participate": "0",
"op_obj_type": "dynaform",
"op_obj_uid": "41320210152964e39d34c91015371856",
"op_action": "block",
"op_case_status": "draft",
"task_target": "task 2",
"group_user": "adam corey (adam)",
"task_source": "task 2",
"object_type": "dynaform",
"object": "eede",
"participated": "no",
"action": "block"
]
[
"op_uid": "69838576352dec9fa91c316052065643",
"pro_uid": "251815090529619a99a2bf4013294414",
"tas_uid": "95655319552a5c790b69a04054667879",
"usr_uid": "20972963752cda4006d1676029328277",
"op_user_relation": "1",
"op_task_source": "95655319552a5c790b69a04054667879",
"op_participate": "0",
"op_obj_type": "dynaform",
"op_obj_uid": "41320210152964e39d34c91015371856",
"op_action": "block",
"op_case_status": "draft",
"task_target": "task 2",
"group_user": "adam corey (adam)",
"task_source": "task 2",
"object_type": "dynaform",
"object": "eede",
"participated": "no",
"action": "block"
]
Create Process Permission: POST project/{prj_uid}/process-permission
Creates a new Process Permission for a project.
Permission:
- Users must have the PM_FACTORY permission assigned to their role to perform this action.
Structure:
POST /api/1.0/{workspace}/project/{prj_uid}/process-permission
Parameters:
-
Name Type Description workspace String Workspace name prj_uid String Project UID
Required Fields:
-
Name Type Description op_user_relation String Determines if the permission is assigned to a user or to a group 1 = user, 2 = group usr_uid String User or group that will have the permission. It depends on op_user_relation op_action String Type of action assigned in the permission op_case_status String The case status that will get permission op_participate String 0 = Not participated, 1 = Participated op_obj_type String Value for the object type of permission
Optional Fields:
-
Name Type Description tas_uid String Task value UID, permission target op_task_source String Task value UID, permission source dynaforms String Dynaform value UID of the permission (Only takes this field into account when the value of "It op_obj_type" is "DYNAFORM" inputs Integer Value of the ID of the input Permission (Only takes this field into account when the value of "op_obj_type" is "INPUT") outputs Integer The output value of the ID Permission (Only takes this field into account when the value of "op_obj_type" is "OUTPUT")
Result:
-
Type Description object Returns an object containing information about the new permission.
Example:
Request
Content-Type: application/json
{
"tas_uid": "",
"usr_uid": "00000000000000000000000000000001",
"op_user_relation": "1",
"op_obj_type": "ANY",
"op_task_source" : "",
"op_participate": "0",
"op_action": "BLOCK",
"op_case_status": "DRAFT"
}
{
"tas_uid": "",
"usr_uid": "00000000000000000000000000000001",
"op_user_relation": "1",
"op_obj_type": "ANY",
"op_task_source" : "",
"op_participate": "0",
"op_action": "BLOCK",
"op_case_status": "DRAFT"
}
Response
201 (Created)
[
"op_uid": "69838576352dec9fa91c316052065643",
"pro_uid": "251815090529619a99a2bf4013294414",
"tas_uid": "95655319552a5c790b69a04054667879",
"usr_uid": "20972963752cda4006d1676029328277",
"op_user_relation": "1",
"op_task_source": "95655319552a5c790b69a04054667879",
"op_participate": "0",
"op_obj_type": "dynaform",
"op_obj_uid": "41320210152964e39d34c91015371856",
"op_action": "block",
"op_case_status": "draft",
"task_target": "task 2",
"group_user": "adam corey (adam)",
"task_source": "task 2",
"object_type": "dynaform",
"object": "eede",
"participated": "no",
"action": "block"
]
[
"op_uid": "69838576352dec9fa91c316052065643",
"pro_uid": "251815090529619a99a2bf4013294414",
"tas_uid": "95655319552a5c790b69a04054667879",
"usr_uid": "20972963752cda4006d1676029328277",
"op_user_relation": "1",
"op_task_source": "95655319552a5c790b69a04054667879",
"op_participate": "0",
"op_obj_type": "dynaform",
"op_obj_uid": "41320210152964e39d34c91015371856",
"op_action": "block",
"op_case_status": "draft",
"task_target": "task 2",
"group_user": "adam corey (adam)",
"task_source": "task 2",
"object_type": "dynaform",
"object": "eede",
"participated": "no",
"action": "block"
]
Update Process Permission: PUT project/{prj_uid}/process-permission/{op_uid}
Updates a Process Permission.
Permission:
- Users must have the PM_FACTORY permission assigned to their role to perform this action.
Structure:
PUT /api/1.0/{workspace}/project/{prj_uid}/process-permission/{op_uid}
Parameters:
-
Name Type Description workspace String Workspace name prj_uid String Project UID op_uid String Process-permissions UID
Required Fields:
-
Name Type Description usr_uid String op_user_relation op_user_relation String 1 = user, 2 = group op_action String Type of action assigned in the permission op_case_status String The state of the case that will get permission op_participate String 0 = Not participated, 1 = Participated op_obj_type String Value for the object type of permission op_action String Type of action assigned in the permission
Optional Fields:
-
Name Type Description tas_uid String Task value UID, permission target op_task_source String Task value UID, permission source dynaforms String Dynaform value UID of the permission (Only takes this field into account when the value of "It op_obj_type" is "DYNAFORM" inputs Integer Value of the ID of the input Permission (Only takes this field into account when the value of "op_obj_type" is "INPUT") outputs Integer The output value of the ID Permission (Only takes this field into account when the value of "op_obj_type" is "OUTPUT")
Result:
-
Type Description empty No return
Example:
Response
200 (OK)
{
"tas_uid": "",
"usr_uid": "00000000000000000000000000000001",
"op_user_relation": "1",
"op_obj_type": "ANY",
"op_task_source" : "",
"op_participate": "0",
"op_action": "BLOCK",
"op_case_status": "TO_DO"
}
{
"tas_uid": "",
"usr_uid": "00000000000000000000000000000001",
"op_user_relation": "1",
"op_obj_type": "ANY",
"op_task_source" : "",
"op_participate": "0",
"op_action": "BLOCK",
"op_case_status": "TO_DO"
}
Delete Process Permission: DELETE project/{prj_uid}/process-permission/{op_uid}
Deletes a Process Permission.
Permission:
- Users must have the PM_FACTORY permission assigned to their role to perform this action.
Structure:
DELETE /api/1.0/{workspace}/project/{prj_uid}/process-permission/{op_uid}
Parameters:
-
Name Type Description workspace String Workspace name prj_uid String Project UID op_uid String Process-permissions UID
Result:
-
Type Description empty No return
Example:
Response
200 (OK)
