Process Supervisor Endpoints
The current methods implemented for the process supervisor resources in the ProcessMaker API designer are listed below:
- Process Supervisor Endpoints
- Get Process Supervisors List:
GET project/{prj_uid}/process-supervisors
- Get Process Supervisor:
GET project/{prj_uid}/process-supervisor/{pu_uid}
- Available Users/Groups to Assign as Process Supervisors:
GET project/{prj_uid}/available-process-supervisors
- Available Groups to Assign as Process Supervisors:
GET project/{prj_uid}/available-process-supervisors?obj_type=group
- Available Users to Assign as Process Supervisors:
GET project/{prj_uid}/available-process-supervisors?obj_type=user
- Get Dynaforms Assigned to Process Supervisors:
GET project/{prj_uid}/process-supervisor/dynaforms
- Get Dynaform Assigned to Process Supervisors:
GET project/{prj_uid}/process-supervisor/dynaform/{pud_uid}
- Available Dynaforms to Assign to Process Supervisors:
GET project/{prj_uid}/process-supervisor/available-dynaforms
- Get Input Documents Assigned to Process Supervisors:
GET project/{prj_uid}/process-supervisor/input-documents
- Available Input Documents to Assign to Process Supervisors:
GET project/{prj_uid}/process-supervisor/available-input-documents
- Get Input Document Assigned to Process Supervisors:
GET project/{prj_uid}/process-supervisor/input-documents/{pui_uid}
- Assign a User/Group as Process Supervisor:
POST project/{prj_uid}/process-supervisor
- Assign Dynaform to Process Supervisors:
POST project/{prj_uid}/process-supervisor/dynaform
- Assign Input Document to Process Supervisor:
POST project/{prj_uid}/process-supervisor/input-document
- Unassign User/Group from Process Supervisors:
DELETE project/{prj_uid}/process-supervisor/{pu_uid}
- Unassign Dynaform from Process Supervisors:
DELETE project/{prj_uid}/process-supervisor/dynaform/{pud_uid}
- Unassign Input Document from Process Supervisors:
DELETE project/{prj_uid}/process-supervisor/input-document/{pui_uid}
- Update Dynaform Assigned to the Process Supervisors:
PUT project/{prj_uid}/process-supervisor/dynaform/{pud_uid}
- Update Input Document Assigned to Process Supervisors:
PUT project/{prj_uid}/process-supervisor/input-document/{pui_uid}
Supervisor Resources:
Name | Description | Type | Value |
---|---|---|---|
pu_uid | A unique ID (UID) assigned to a user or group when they are designated as a Process Supervisor. | String | String Alphanumeric |
pu_type | User type | String | Alphanumeric string: "Supervisor" or "Group_supervisor" |
usr_uid | User UID | String | Alphanumeric string |
usr_username | Username | String | Alphabetic string |
usr_firstname | User first name | String | Alphabetic string |
usr_lastname | User last name | String | Alphanumeric string |
usr_email | User email | String | Alphanumeric string |
grp_uid | Group UID | String | Alphanumeric string |
grp_name | Group name | String | Alphanumeric string |
obj_type | Type | String | Alphabetic string "user" or "group" |
pud_uid | The unique ID (UID) assigned to the Dynaform when it is designated as an assigned object | String | Alphanumeric string |
pud_position | Dynaform position | Number | Numeric Value |
dyn_uid | Dynaform UID | String | Alphanumeric string |
dyn_title | Dynaform name | String | Alphanumeric string |
pui_uid | The unique ID (UID) assigned to the Input Document when it is designated as an assigned object. | String | Alphanumeric string |
pui_position | Input document position | Number | Numeric Value |
inp_doc_uid | Input document UID | String | Alphanumeric string |
inp_doc__title | Input document title | String | Alphanumeric string |
Information about each method is written in the section below:
Get Process Supervisors List: GET project/{prj_uid}/process-supervisors
Gets the list of Process Supervisors in a project.
GET /api/1.0/{workspace}/project/{prj_uid}/process-supervisors
Parameters:
-
Name Type Description workspace String Workspace name prj_uid String Project UID
Result:
-
Type Description array Returns an array of users and groups assigned as process supervisors
Example:
Response
Content-Type: application/json
[
{
"pu_uid": "17802550052cc5973dc7c80089693850",
"pu_type": "SUPERVISOR",
"usr_uid": "70798526351ed3cf988be33081236564",
"usr_username": "jdoe",
"usr_firstname": "John",
"usr_lastname": "Doe",
"usr_email": "jdoe@colosa.com"
},
{
"pu_uid": "08969385017802550052cc5973dc7c80",
"pu_type": "GROUP_SUPERVISOR",
"grp_uid": "3cf988be3308123656470798526351ed",
"grp_name": "Admins"
}
]
Get Process Supervisor: GET project/{prj_uid}/process-supervisor/{pu_uid}
Gets a specified process supervisor.
GET /api/1.0/{workspace}/project/{prj_uid}/process-supervisor/{pu_uid}
Parameters:
-
Name Type Description workspace String Workspace name prj_uid String Process UID pu_uid String The unique ID (UID) assigned to the user or group when they are designated as a Process Supervisor.
Result:
-
Type Description object Returns an object containing the specified process supervisor.
Example:
Response
{
"pu_uid": "17802550052cc5973dc7c80089693850",
"pu_type": "SUPERVISOR",
"usr_uid": "70798526351ed3cf988be33081236564",
"usr_username": "jdoe",
"usr_firstname": "John",
"usr_lastname": "Doe",
"usr_email": "jdoe@colosa.com"
}
Available Users/Groups to Assign as Process Supervisors: GET project/{prj_uid}/available-process-supervisors
Gets the list of the available users and groups, that may be assigned as Process Supervisors.
GET /api/1.0/{workspace}/project/{prj_uid}/available-process-supervisors
Parameters:
-
Name Type Description workspace String Workspace name prj_uid String Project UID
Result:
-
Type Description array Returns an array of available users and groups objects
Example:
Response
Content-Type: application/json
[
{
"grp_uid": "17203362252b88ac7c89213094619445",
"grp_name": "Web Users",
"obj_type": "group"
},
{
"usr_uid": "00000000000000000000000000000001",
"usr_firstname": "Administrator",
"usr_lastname": "Admin",
"usr_username": "admin",
"usr_email": "admin@processmaker.com",
"obj_type": "user"
}
]
Available Groups to Assign as Process Supervisors: GET project/{prj_uid}/available-process-supervisors?obj_type=group
Gets the available groups to assign as Process Supervisors.
GET /api/1.0/{workspace}/project/{prj_uid}/available-process-supervisors?obj_type=group
Parameters:
-
Name Type Description workspace String Workspace name prj_uid String Project UID
Optional Parameters:
-
Name Type Description obj_type String Alphabetic string containing the name of the user or group
Result:
-
Type Description array Returns an array of groups objects
Example:
Response
Content-Type: application/json
[
{
"grp_uid": "17203362252b88ac7c89213094619445",
"grp_name": "Admins"
},
{
"grp_uid": "52b88ac7c89213094619445172033622",
"grp_name": "Maganers"
},
{
"grp_uid": "09461944517203362252b88ac7c89213",
"grp_name": "Web Users"
}
]
Available Users to Assign as Process Supervisors: GET project/{prj_uid}/available-process-supervisors?obj_type=user
Gets the list of the available users to assign as process supervisors.
GET /api/1.0/{workspace}/project/{prj_uid}/available-process-supervisors?obj_type=user
Parameters:
-
Name Type Description workspace String Workspace name prj_uid String Project UID
Optional Parameters:
-
Name Type Description obj_type String Alphabetic string containing the name of the user or group
Result:
-
Type Description array Returns an array with one-level data
Example:
Response
Content-Type: application/json
[
{
"usr_uid": "00000000000000000000000000000001",
"usr_firstname": "Administrator",
"usr_lastname": "Admin",
"usr_username": "",
"usr_email": "admin@colosa.com"
},
{
"usr_uid": "c7c8921309461944517203362252b88a",
"usr_firstname": "John",
"usr_lastname": "Doe",
"usr_username": "jdoe",
"usr_email": "jdoe@colosa.com"
}
]
Get Dynaforms Assigned to Process Supervisors: GET project/{prj_uid}/process-supervisor/dynaforms
Gets the list of Dynaforms assigned to the process supervisors.
GET /api/1.0/{workspace}/project/{prj_uid}/process-supervisor/dynaforms
Parameters:
-
Name Type Description workspace String Workspace name prj_uid String Project UID
Result:
-
Type Description array Returns an array of objects containing the Dynaforms' data
Example:
Response
Content-Type: application/json
[
{
"pud_uid": "57883171852cc5265564b92004742683",
"pud_position": "1",
"dyn_uid": "766433290522e23c7941be3033545453",
"dyn_title": "Dynaform #1"
},
{
"pud_uid": "520047426837883171852cc5265564b9",
"pud_position": "2",
"dyn_uid": "23c7941be3033545453766433290522e",
"dyn_title": "Dynaform #2"
}
]
Get Dynaform Assigned to Process Supervisors: GET project/{prj_uid}/process-supervisor/dynaform/{pud_uid}
Gets a specified Dynaform assigned to the Process Supervisors.
GET /api/1.0/{workspace}/project/{prj_uid}/process-supervisor/dynaform/{pud_uid}
Parameters:
-
Name Type Description workspace String Workspace name prj_uid String Project UID pud_uid String The unique ID (UID) assigned to the Dynaform when it is designated as an assigned object
Result:
-
Type Description object Returns an object containing the Dynaform data
Example:
Response
Content-Type: application/json
{
"pud_uid": "57883171852cc5265564b92004742683",
"pud_position": "1",
"dyn_uid": "766433290522e23c7941be3033545453",
"dyn_title": "Dynaform #1"
}
Available Dynaforms to Assign to Process Supervisors: GET project/{prj_uid}/process-supervisor/available-dynaforms
Gets the list of Dynaforms that are available to be assigned to Process Supervisors.
GET /api/1.0/{workspace}/project/{prj_uid}/process-supervisor/available-dynaforms
Parameters:
-
Name Type Description workspace String Workspace name prj_uid String Project UID
Result:
-
Type Description array Returns an array of objects containing the Dynaform's data
Example:
Response
Content-Type: application/json
[
{
"dyn_uid": "2e23c7941be303354545376643329052",
"dyn_title": "Dynaform #3"
},
{
"dyn_uid": "9200474268357883171852cc5265564b",
"dyn_title": "Dynaform #4"
}
]
Get Input Documents Assigned to Process Supervisors: GET project/{prj_uid}/process-supervisor/input-documents
Gets the list of Input Documents assigned to the Process Supervisors.
GET /api/1.0/{workspace}/project/{prj_uid}/process-supervisor/input-documents
Parameters:
-
Name Type Description workspace String Workspace name prj_uid String Project UID
Result:
-
Type Description array Returns an array of objects containing the input document's data
Example:
Response
Content-Type: application/json
[
{
"pui_uid": "57883171852cc5265564b92004742683",
"pui_position": "1",
"input_doc_uid": "766433290522e23c7941be3033545453",
"input_doc_title": "Input Document #1"
},
{
"pui_uid": "520047426837883171852cc5265564b9",
"pui_position": "2",
"input_doc_uid": "23c7941be3033545453766433290522e",
"input_doc_title": "Input Document #2"
}
]
Available Input Documents to Assign to Process Supervisors: GET project/{prj_uid}/process-supervisor/available-input-documents
Gets the available input documents to assign to the Process Supervisors.
GET /api/1.0/{workspace}/project/{prj_uid}/process-supervisor/available-input-documents
Parameters:
-
Name Type Description workspace String Workspace name prj_uid String Project UID
Result:
-
Type Description array Returns an array of objects containing the available input documents' data
Example:
Response
Content-Type: application/json
[
{
"inp_doc_uid": "2e23c7941be303354545376643329052",
"inp_doc_title": "Input Document #3"
},
{
"inp_doc_uid": "3766433290522e23c7941be303354545",
"inp_doc_title": "Input Document #4"
}
]
Get Input Document Assigned to Process Supervisors: GET project/{prj_uid}/process-supervisor/input-documents/{pui_uid}
Gets an Input Document assigned to the Process Supervisors.
GET /api/1.0/{workspace}/project/{prj_uid}/process-supervisor/input-documents/{pui_uid}
Parameters:
-
Name Type Description workspace String Workspace name prj_uid String Project UID pui_uid String The unique ID (UID) assigned to the Input Document when is designated as an assigned object.
Result:
-
Type Description object Returns an object contaning the input document's data
Example:
Response
{
"pui_uid": "520047426837883171852cc5265564b9",
"pui_position": "2",
"input_doc_uid": "23c7941be3033545453766433290522e",
"input_doc_title": "Input Document #2"
}
Assign a User/Group as Process Supervisor: POST project/{prj_uid}/process-supervisor
Assign a user or group as a process supervisor.
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-supervisor
Parameters:
-
Name Type Description workspace String Workspace name prj_uid String Project UID
Required Fields:
-
Name Type Description pu_type String Specifies whether it is a user (pu_type = SUPERVISOR) or group (pu_type = GROUP_SUPERVISOR) usr_uid / grp_uid String User UID / Group UID
Optional Fields:
-
Name Type Description usr_username String Username usr_firstname String User first name usr_lastname String User last name usr_email String User email grp_name String Group name obj_type String Alphabetic string containing the name of the user or group
Result:
-
Type Description object Returns an object containing data about the user/group - supervisor relationship.
Example:
Request
{
"pu_type": "SUPERVISOR",
"usr_uid": "70798526351ed3cf988be33081236564",
}
Response
{
"pu_uid": "17802550052cc5973dc7c80089693850",
"pu_type": "SUPERVISOR",
"usr_uid": "70798526351ed3cf988be33081236564",
"usr_username": "jdoe",
"usr_firstname": "John",
"usr_lastname": "Doe",
"usr_email": "jdoe@colosa.com"
}
Assign Dynaform to Process Supervisors: POST project/{prj_uid}/process-supervisor/dynaform
Assigns a Dynaform to a Process Supervisor.
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-supervisor/dynaform
Parameters:
-
Name Type Description workspace String Workspace name prj_uid String Project UID
Required Fields:
-
Name Type Description dyn_uid String Dynaform UID
Optional Fields:
-
Name Type Description pud_position String Position
Result:
-
Type Description object Returns an object containing the information about the Dynaform's designation as an assigned object.
Example:
Request
{
"pud_position": "1",
"dyn_uid": "766433290522e23c7941be3033545453",
}
Response
{
"pud_uid": "57883171852cc5265564b92004742683",
"pud_position": "1",
"dyn_uid": "766433290522e23c7941be3033545453",
"dyn_title": "Dynaform #1"
}
Assign Input Document to Process Supervisor: POST project/{prj_uid}/process-supervisor/input-document
Assigns an input document to a Process Supervisor.
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-supervisor/input-document
Parameters:
-
Name Type Description workspace String Workspace name prj_uid String Project UID
Required Fields:
-
Name Type Description inp_doc_uid String Input Document UID
Optional Fields:
-
Name Type Description pui_position String Position
Result:
-
Type Description object Returns an object containing the information about the assignment of an Input Document as a process supervisor object.
Example:
Request
{
"pui_position": "1",
"input_doc_uid": "766433290522e23c7941be3033545453",
}
Response
{
"pui_uid": "57883171852cc5265564b92004742683",
"pui_position": "1",
"input_doc_uid": "766433290522e23c7941be3033545453",
"input_doc_title": "Input Document #1"
}
Unassign User/Group from Process Supervisors: DELETE project/{prj_uid}/process-supervisor/{pu_uid}
Unassigns a user or group from the Process Supervisors.
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-supervisor/{pu_uid}
Parameters:
-
Name Type Description workspace String Workspace name prj_uid String Project UID pu_uid String The unique ID (UID) assigned to the user or group when they are designated as a Process Supervisor.
Result:
-
Type Description empty No return
Example:
Response
Unassign Dynaform from Process Supervisors: DELETE project/{prj_uid}/process-supervisor/dynaform/{pud_uid}
Unassign a Dynaform from the Process Supervisors.
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-supervisor/dynaform/{pud_uid}
Parameters:
-
Name Type Description workspace String Workspace name prj_uid String Project UID pud_uid String The unique ID (UID) assigned to the Dynaform when it is designated as an assigned object.
Result:
-
Type Description empty No return
Example:
Response
Unassign Input Document from Process Supervisors: DELETE project/{prj_uid}/process-supervisor/input-document/{pui_uid}
Unassign an Input Document from the Process Supervisors.
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-supervisor/input-document/{pui_uid}
Parameters:
-
Name Type Description workspace String Workspace name prj_uid String Project UID pui_uid String The unique ID (UID) assigned to the Input Document when is designated as an Assigned object.
Result:
-
Type Description empty No return
Example:
Response
Update Dynaform Assigned to the Process Supervisors: PUT project/{prj_uid}/process-supervisor/dynaform/{pud_uid}
Updates a Dynaform assigned to the Process Supervisors.
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-supervisor/dynaform/{pud_uid}
Parameters:
-
Name Type Description workspace String Workspace name prj_uid String Project UID pud_uid String The unique ID (UID) assigned to the Dynaform when it is designated as an assigned object.
Optional Fields:
-
Name Type Description pud_position String Dynaform position
Result:
-
Type Description object Returns an object containing the information about the assignment of a Dynaform as a process supervisor object.
Example:
Request
{
"pud_position": ”1”
}
Response
{
"pui_uid": "57883171852cc5265564b92004742683",
"pud_position": "1",
"dyn_uid": "766433290522e23c7941be3033545453",
"dyn_title": "Dynaform #1"
}
Update Input Document Assigned to Process Supervisors: PUT project/{prj_uid}/process-supervisor/input-document/{pui_uid}
Updates an input document assigned to the Process Supervisors.
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-supervisor/input-document/{pui_uid}
Parameters:
-
Name Type Description workspace String Workspace name prj_uid String Project UID pui_uid String The unique ID (UID) assigned to the Input Document when is designated as an assigned object.
Optional Fields:
-
Name Type Description pui_position String Input document position
Result:
-
Type Description object Returns an object
Example:
Request
{
"pud_position": ”1”
}
Response
{
"pui_uid": "57883171852cc5265564b92004742683",
"pud_position": "1",
"dyn_uid": "766433290522e23c7941be3033545453",
"dyn_title": "Dynaform #1"
}