Please rate how useful you found this document:
Web Entry
The current methods implemented for web entries in the ProcessMaker API designer are listed below:
Contents: [hide]
- Web Entry
- Get Web Entries List:
GET project/{prj_uid}/web-entries - Get Web Entry:
GET project/{prj_uid}/web-entry/{we_uid} - Create Web Entry:
POST project/{prj_uid}/web-entry - Create Web Entry with HTML Page:
POST project/{prj_uid}/web-entry - Update Web Entry:
PUT project/{prj_uid}/web-entry/{we_uid} - Delete Web Entry:
DELETE project/{prj_uid}/web-entry/{we_uid}
Web Entry:
| Name | Description | Type | Value |
|---|---|---|---|
| we_uid | Web entry UID | String | "9541049475298f190420f51086854718" (String of 32 characters) |
| tas_uid | Task UID | String | "9541049475298f190420f51086854718" (String of 32 characters) |
| dyn_uid | Dynaform UID | String | "9541049475298f190420f51086854718" (String of 32 characters) |
| usr_uid | User UID | String | "9541049475298f190420f51086854718" (String of 32 characters) |
| we_title | Title | String | "My dynaform" |
| we_description | Description | String | "Description" |
| we_method | Creation method | String | "WS", "HTML" (unique values) |
| we_input_document_access | Input Document Access | Integer | 0, 1 (unique values) 0: Restricted to process permissions 1: No Restriction |
| we_data | Data | String | "9541049475298f190420f51086854718" (String of 32 characters) |
| we_create_usr_uid | UID of the user who created the process. | String | "9541049475298f190420f51086854718" (String of 32 characters) |
| we_update_usr_uid | UID of the user who updated the registry. | String | "9541049475298f190420f51086854718" (String of 32 characters) |
| we_create_date | Creation date (According to the setting in "Global Date Format"). | Datetime | “2012-10-22 14:51:11” |
| we_update_date | Update date (According to the setting in "Global Date Format") | Datetime | “2012-10-22 14:51:11” |
Get Web Entries List: GET project/{prj_uid}/web-entries
Gets the list of the Web Entries in a project.
GET /api/1.0/{workspace}/project/{prj_uid}/web-entries
Parameters:
-
Name Type Description workspace String Workspace name. prj_uid String Project UID
Result:
-
Type Description array Returns an array of objects containing data about each web entry.
Example:
Response
200 (OK)
Content-Type: application/json
[
{
"we_uid": "74091011859b3147542c7d7053314431",
"tas_uid": "wee-85407599dc4d2395a86036163818",
"dyn_uid": "1094554005996fcfb4bde64064753299",
"usr_uid": "00000000000000000000000000000001",
"we_title": "832485407599dc4d2395a86036163818",
"we_description": "Web Entry Description...",
"we_method": "WS",
"we_input_document_access": 1,
"we_data": "http://your_pm_server/sysworkflow/en/neoclassic/8061532405176da5242da84006421863/My_DynaForm_1.php",
"we_create_usr_uid": "00000000000000000000000000000001",
"we_update_usr_uid": "00000000000000000000000000000001",
"we_create_date": "2017-09-08T19:06:45-03:00",
"we_update_date": "2017-09-12T12:21:05-03:00"
},
{
...
}
]
Content-Type: application/json
[
{
"we_uid": "74091011859b3147542c7d7053314431",
"tas_uid": "wee-85407599dc4d2395a86036163818",
"dyn_uid": "1094554005996fcfb4bde64064753299",
"usr_uid": "00000000000000000000000000000001",
"we_title": "832485407599dc4d2395a86036163818",
"we_description": "Web Entry Description...",
"we_method": "WS",
"we_input_document_access": 1,
"we_data": "http://your_pm_server/sysworkflow/en/neoclassic/8061532405176da5242da84006421863/My_DynaForm_1.php",
"we_create_usr_uid": "00000000000000000000000000000001",
"we_update_usr_uid": "00000000000000000000000000000001",
"we_create_date": "2017-09-08T19:06:45-03:00",
"we_update_date": "2017-09-12T12:21:05-03:00"
},
{
...
}
]
Get Web Entry: GET project/{prj_uid}/web-entry/{we_uid}
Gets a specified Web Entry.
GET /api/1.0/{workspace}/project/{prj_uid}/web-entry/{we_uid}
Parameters:
-
Name Type Description workspace String Workspace name. prj_uid String Project UID we_uid String Web entry UID
Result:
-
Type Description object Returns an object containing information about the Web Entry.
Example:
Response
200 (OK)
Content-Type: application/json
{
"we_uid": "74091011859b3147542c7d7053314431",
"tas_uid": "wee-85407599dc4d2395a86036163818",
"dyn_uid": "1094554005996fcfb4bde64064753299",
"usr_uid": "00000000000000000000000000000001",
"we_title": "832485407599dc4d2395a86036163818",
"we_description": "Description...",
"we_method": "WS",
"we_input_document_access": 1,
"we_data": "http://your_pm_server/sysworkflow/en/neoclassic/8061532405176da5242da84006421863/My_DynaForm_1.php",
"we_create_usr_uid": "00000000000000000000000000000001",
"we_update_usr_uid": "00000000000000000000000000000001",
"we_create_date": "2017-09-08T19:06:45-03:00",
"we_update_date": "2017-09-12T12:21:05-03:00"
}
Content-Type: application/json
{
"we_uid": "74091011859b3147542c7d7053314431",
"tas_uid": "wee-85407599dc4d2395a86036163818",
"dyn_uid": "1094554005996fcfb4bde64064753299",
"usr_uid": "00000000000000000000000000000001",
"we_title": "832485407599dc4d2395a86036163818",
"we_description": "Description...",
"we_method": "WS",
"we_input_document_access": 1,
"we_data": "http://your_pm_server/sysworkflow/en/neoclassic/8061532405176da5242da84006421863/My_DynaForm_1.php",
"we_create_usr_uid": "00000000000000000000000000000001",
"we_update_usr_uid": "00000000000000000000000000000001",
"we_create_date": "2017-09-08T19:06:45-03:00",
"we_update_date": "2017-09-12T12:21:05-03:00"
}
Create Web Entry: POST project/{prj_uid}/web-entry
Creates a new Web Entry using the method "PHP pages with Web Services".
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}/web-entry
Parameters:
-
Name Type Description workspace String Workspace name. prj_uid String Project UID
Required Fields:
-
Name Type Description tas_uid String Task UID dyn_uid String Dynaform UID usr_uid String User UID we_title String Title we_method String Creation method = "WS" we_input_document_access String Input document access
Optional Fields:
-
Name Type Description we_description String Description we_data String Data
Result:
-
Type Description object Returns an object containing information about the web entry plus the "we_uid" attribute.
Example:
Request
Content-Type: application/json
{
"tas_uid": "90179407652dfd8022a69c4009728891",
"dyn_uid": "41124331652de92e93bff96031343341",
"usr_uid": "00000000000000000000000000000001",
"we_title": "My DynaForm 1",
"we_description": "Description...",
"we_method": "WS",
"we_input_document_access": 1
}
{
"tas_uid": "90179407652dfd8022a69c4009728891",
"dyn_uid": "41124331652de92e93bff96031343341",
"usr_uid": "00000000000000000000000000000001",
"we_title": "My DynaForm 1",
"we_description": "Description...",
"we_method": "WS",
"we_input_document_access": 1
}
Response
201 (Created)
{
"we_uid": "587419583511e8b709dcc89064621895",
"tas_uid": "90179407652dfd8022a69c4009728891",
"dyn_uid": "41124331652de92e93bff96031343341",
"usr_uid": "00000000000000000000000000000001",
"we_title": "My DynaForm 1",
"we_description": "Description...",
"we_method": "WS",
"we_input_document_access": 1,
"we_data": "http://your_pm_server/sysworkflow/en/neoclassic/8061532405176da5242da84006421863/My_DynaForm_1.php",
"we_create_usr_uid": "00000000000000000000000000000001",
"we_update_usr_uid": "",
"we_create_date": "2014/04/16",
"we_update_date": ""
}
{
"we_uid": "587419583511e8b709dcc89064621895",
"tas_uid": "90179407652dfd8022a69c4009728891",
"dyn_uid": "41124331652de92e93bff96031343341",
"usr_uid": "00000000000000000000000000000001",
"we_title": "My DynaForm 1",
"we_description": "Description...",
"we_method": "WS",
"we_input_document_access": 1,
"we_data": "http://your_pm_server/sysworkflow/en/neoclassic/8061532405176da5242da84006421863/My_DynaForm_1.php",
"we_create_usr_uid": "00000000000000000000000000000001",
"we_update_usr_uid": "",
"we_create_date": "2014/04/16",
"we_update_date": ""
}
Create Web Entry with HTML Page: POST project/{prj_uid}/web-entry
Creates a Web Entry using the method "Single HTML" page.
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}/web-entry
Parameters:
-
Name Type Description workspace String Workspace name. prj_uid String Project UID
Required Fields:
-
Name Type Description tas_uid String Task UID dyn_uid String Dynaform UID we_title String Title we_method String Creation method = "HTML" we_input_document_access String Input document access
Optional Fields:
-
Name Type Description usr_uid String User UID we_description String Description we_data String Data
Result:
-
Type Description object Returns an object containing information about the web entry plus the "we_uid" attribute.
Example:
Request
Content-Type: application/json
{
"tas_uid": "821603509526eae5e100ac2043080803",
"dyn_uid": "2820662365261577c336381090786467",
"we_title": "My DynaForm 2",
"we_description": "Description...",
"we_method": "HTML",
"we_input_document_access": 1
}
{
"tas_uid": "821603509526eae5e100ac2043080803",
"dyn_uid": "2820662365261577c336381090786467",
"we_title": "My DynaForm 2",
"we_description": "Description...",
"we_method": "HTML",
"we_input_document_access": 1
}
Response
201 (Created)
{
"we_uid": "518973060512235cb814be8004067411",
"tas_uid": "821603509526eae5e100ac2043080803",
"dyn_uid": "2820662365261577c336381090786467",
"usr_uid": "",
"we_title": "My DynaForm 2",
"we_description": "Description...",
"we_method": "HTML",
"we_input_document_access": 1,
"we_data": "<html>...</html>",
"we_create_usr_uid": "00000000000000000000000000000001",
"we_update_usr_uid": "",
"we_create_date": "2014/04/16",
"we_update_date": ""
}
{
"we_uid": "518973060512235cb814be8004067411",
"tas_uid": "821603509526eae5e100ac2043080803",
"dyn_uid": "2820662365261577c336381090786467",
"usr_uid": "",
"we_title": "My DynaForm 2",
"we_description": "Description...",
"we_method": "HTML",
"we_input_document_access": 1,
"we_data": "<html>...</html>",
"we_create_usr_uid": "00000000000000000000000000000001",
"we_update_usr_uid": "",
"we_create_date": "2014/04/16",
"we_update_date": ""
}
Update Web Entry: PUT project/{prj_uid}/web-entry/{we_uid}
Updates a specified Web Entry.
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}/web-entry/{we_uid}
Parameters:
-
Name Type Description workspace String Workspace name. prj_uid String Project UID we_uid String Web entry UID
Optional Fields:
-
Name Type Description tas_uid String Task UID dyn_uid String Dynaform UID usr_uid String User UID we_title String Title we_description String Description we_method String Creation method we_input_document_access String Input document access we_data String Data
Result:
-
Type Description empty No return
Example:
Request
Content-Type: application/json
{
"tas_uid": "90179407652dfd8022a69c4009728891",
"dyn_uid": "41124331652de92e93bff96031343341",
"usr_uid": "00000000000000000000000000000001",
"we_title": "My DynaForm 1",
"we_description": "Description...",
"we_method": "WS",
"we_input_document_access": 1
}
{
"tas_uid": "90179407652dfd8022a69c4009728891",
"dyn_uid": "41124331652de92e93bff96031343341",
"usr_uid": "00000000000000000000000000000001",
"we_title": "My DynaForm 1",
"we_description": "Description...",
"we_method": "WS",
"we_input_document_access": 1
}
Response
200(OK)
Delete Web Entry: DELETE project/{prj_uid}/web-entry/{we_uid}
Deletes a specified Web Entry.
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}/web-entry/{we_uid}
Parameters:
-
Name Type Description workspace String Workspace name. prj_uid String Project UID we_uid String Web entry UID
Result:
-
Type Description empty No return
Example:
Response
200(OK)
