updating apiary docs source
This commit is contained in:
137
apiary.apib
137
apiary.apib
@@ -150,44 +150,25 @@ POST /token
|
|||||||
"refresh_token": "9ed17b93a0731e218a3a85b52974afaf23838337"
|
"refresh_token": "9ed17b93a0731e218a3a85b52974afaf23838337"
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|
||||||
--
|
--
|
||||||
Project Resources
|
Project Resources
|
||||||
--
|
|
||||||
|
|
||||||
Edit project attributes
|
|
||||||
GET /project/{prj_uid}/
|
|
||||||
< 200
|
|
||||||
< Content-Type: application/json
|
|
||||||
{
|
|
||||||
"prj_uid": "154619055527bbbbea27110004783861",
|
|
||||||
"prj_title": "Project #1",
|
|
||||||
"prj_description": "Project #1 Description",
|
|
||||||
"prj_calendar": "",
|
|
||||||
"prj_category": "",
|
|
||||||
"prj_summary_dynaform": "",
|
|
||||||
"prj_derivation_screen": "",
|
|
||||||
"prj_debug": "",
|
|
||||||
"prj_show_message": "",
|
|
||||||
"prj_subprocess": "",
|
|
||||||
"prj_tri_deleted": "",
|
|
||||||
"prj_tri_cancelled": "",
|
|
||||||
"prj_tri_paused": "",
|
|
||||||
"prj_tri_reasingned": ""
|
|
||||||
}
|
|
||||||
|
|
||||||
--
|
|
||||||
Project Diagram Resources
|
|
||||||
The following is a section of resources related to ProcessMaker Process Definition
|
The following is a section of resources related to ProcessMaker Process Definition
|
||||||
--
|
--
|
||||||
|
|
||||||
List project `diagrams`
|
Get a list of `projects`
|
||||||
GET /project/{prj_uid}/diagrams
|
GET /projects
|
||||||
< 200
|
< 200
|
||||||
< Content-Type: application/json
|
< Content-Type: application/json
|
||||||
|
[
|
||||||
|
{
|
||||||
|
"prj_uid" : "8061532405176da5242da84006421863",
|
||||||
|
"prj_name" : "Sample Project",
|
||||||
|
"prj_description" : "sample desc",
|
||||||
|
"diagrams":
|
||||||
[
|
[
|
||||||
{
|
{
|
||||||
"diag_uid": "a5242da840064218638061532405176",
|
"diag_uid": "a5242da840064218638061532405176",
|
||||||
"pro_uid": "8061532405176da5242da84006421863",
|
|
||||||
"laneset": [],
|
"laneset": [],
|
||||||
"lanes": [],
|
"lanes": [],
|
||||||
"activities":
|
"activities":
|
||||||
@@ -231,8 +212,8 @@ GET /project/{prj_uid}/diagrams
|
|||||||
{
|
{
|
||||||
"evn_uid": "960500897525d8eb8fb84b4013700338",
|
"evn_uid": "960500897525d8eb8fb84b4013700338",
|
||||||
"evn_name":null,
|
"evn_name":null,
|
||||||
"evn_type":null,
|
"evn_type":"",
|
||||||
"evn_marker":null,
|
"evn_marker":"",
|
||||||
"evn_is_interrupting":true,
|
"evn_is_interrupting":true,
|
||||||
"evn_attached_to":null,
|
"evn_attached_to":null,
|
||||||
"evn_cancel_activity":false,
|
"evn_cancel_activity":false,
|
||||||
@@ -249,7 +230,7 @@ GET /project/{prj_uid}/diagrams
|
|||||||
"evn_time_date":null,
|
"evn_time_date":null,
|
||||||
"evn_time_cycle":null,
|
"evn_time_cycle":null,
|
||||||
"evn_time_duration":null,
|
"evn_time_duration":null,
|
||||||
"evn_behavior":null,
|
"evn_behavior":"",
|
||||||
"bou_x":87,
|
"bou_x":87,
|
||||||
"bou_y":261,
|
"bou_y":261,
|
||||||
"bou_width":33,
|
"bou_width":33,
|
||||||
@@ -260,8 +241,8 @@ GET /project/{prj_uid}/diagrams
|
|||||||
{
|
{
|
||||||
"evn_uid": "941908090525d8ec7fb8a07093841901",
|
"evn_uid": "941908090525d8ec7fb8a07093841901",
|
||||||
"evn_name":null,
|
"evn_name":null,
|
||||||
"evn_type":null,
|
"evn_type":"",
|
||||||
"evn_marker":null,
|
"evn_marker":"",
|
||||||
"evn_is_interrupting":true,
|
"evn_is_interrupting":true,
|
||||||
"evn_attached_to":null,
|
"evn_attached_to":null,
|
||||||
"evn_cancel_activity":false,
|
"evn_cancel_activity":false,
|
||||||
@@ -278,7 +259,7 @@ GET /project/{prj_uid}/diagrams
|
|||||||
"evn_time_date":null,
|
"evn_time_date":null,
|
||||||
"evn_time_cycle":null,
|
"evn_time_cycle":null,
|
||||||
"evn_time_duration":null,
|
"evn_time_duration":null,
|
||||||
"evn_behavior":null,
|
"evn_behavior":"",
|
||||||
"bou_x":903,
|
"bou_x":903,
|
||||||
"bou_y":303,
|
"bou_y":303,
|
||||||
"bou_width":33,
|
"bou_width":33,
|
||||||
@@ -379,14 +360,21 @@ GET /project/{prj_uid}/diagrams
|
|||||||
"artifacts": []
|
"artifacts": []
|
||||||
}
|
}
|
||||||
]
|
]
|
||||||
|
}
|
||||||
|
]
|
||||||
|
|
||||||
Get a single project `diagram`
|
Get a single `project`
|
||||||
GET /project/{prj_uid}/diagram/{dia_uid}
|
GET /project/{prj_uid}
|
||||||
< 200
|
< 200
|
||||||
< Content-Type: application/json
|
< Content-Type: application/json
|
||||||
|
{
|
||||||
|
"prj_uid" : "8061532405176da5242da84006421863",
|
||||||
|
"prj_name" : "Sample Project",
|
||||||
|
"prj_description" : "sample desc",
|
||||||
|
"diagrams":
|
||||||
|
[
|
||||||
{
|
{
|
||||||
"diag_uid": "a5242da840064218638061532405176",
|
"diag_uid": "a5242da840064218638061532405176",
|
||||||
"pro_uid": "8061532405176da5242da84006421863",
|
|
||||||
"laneset": [],
|
"laneset": [],
|
||||||
"lanes": [],
|
"lanes": [],
|
||||||
"activities":
|
"activities":
|
||||||
@@ -430,8 +418,8 @@ GET /project/{prj_uid}/diagram/{dia_uid}
|
|||||||
{
|
{
|
||||||
"evn_uid": "960500897525d8eb8fb84b4013700338",
|
"evn_uid": "960500897525d8eb8fb84b4013700338",
|
||||||
"evn_name":null,
|
"evn_name":null,
|
||||||
"evn_type":null,
|
"evn_type":"",
|
||||||
"evn_marker":null,
|
"evn_marker":"",
|
||||||
"evn_is_interrupting":true,
|
"evn_is_interrupting":true,
|
||||||
"evn_attached_to":null,
|
"evn_attached_to":null,
|
||||||
"evn_cancel_activity":false,
|
"evn_cancel_activity":false,
|
||||||
@@ -448,7 +436,7 @@ GET /project/{prj_uid}/diagram/{dia_uid}
|
|||||||
"evn_time_date":null,
|
"evn_time_date":null,
|
||||||
"evn_time_cycle":null,
|
"evn_time_cycle":null,
|
||||||
"evn_time_duration":null,
|
"evn_time_duration":null,
|
||||||
"evn_behavior":null,
|
"evn_behavior":"",
|
||||||
"bou_x":87,
|
"bou_x":87,
|
||||||
"bou_y":261,
|
"bou_y":261,
|
||||||
"bou_width":33,
|
"bou_width":33,
|
||||||
@@ -459,8 +447,8 @@ GET /project/{prj_uid}/diagram/{dia_uid}
|
|||||||
{
|
{
|
||||||
"evn_uid": "941908090525d8ec7fb8a07093841901",
|
"evn_uid": "941908090525d8ec7fb8a07093841901",
|
||||||
"evn_name":null,
|
"evn_name":null,
|
||||||
"evn_type":null,
|
"evn_type":"",
|
||||||
"evn_marker":null,
|
"evn_marker":"",
|
||||||
"evn_is_interrupting":true,
|
"evn_is_interrupting":true,
|
||||||
"evn_attached_to":null,
|
"evn_attached_to":null,
|
||||||
"evn_cancel_activity":false,
|
"evn_cancel_activity":false,
|
||||||
@@ -477,7 +465,7 @@ GET /project/{prj_uid}/diagram/{dia_uid}
|
|||||||
"evn_time_date":null,
|
"evn_time_date":null,
|
||||||
"evn_time_cycle":null,
|
"evn_time_cycle":null,
|
||||||
"evn_time_duration":null,
|
"evn_time_duration":null,
|
||||||
"evn_behavior":null,
|
"evn_behavior":"",
|
||||||
"bou_x":903,
|
"bou_x":903,
|
||||||
"bou_y":303,
|
"bou_y":303,
|
||||||
"bou_width":33,
|
"bou_width":33,
|
||||||
@@ -577,13 +565,21 @@ GET /project/{prj_uid}/diagram/{dia_uid}
|
|||||||
],
|
],
|
||||||
"artifacts": []
|
"artifacts": []
|
||||||
}
|
}
|
||||||
|
]
|
||||||
|
}
|
||||||
|
|
||||||
Create a new project `diagram`
|
|
||||||
POST /project/{prj_uid}/diagram/{dia_uid}
|
Create a new `project`
|
||||||
|
POST /project
|
||||||
> Content-Type: application/json
|
> Content-Type: application/json
|
||||||
{
|
{
|
||||||
"dia_uid": "a5242da840064218638061532405176",
|
"prj_uid" : "8061532405176da5242da84006421863",
|
||||||
"pro_uid": "8061532405176da5242da84006421863",
|
"prj_name" : "Sample Project",
|
||||||
|
"prj_description" : "sample desc",
|
||||||
|
"diagrams":
|
||||||
|
[
|
||||||
|
{
|
||||||
|
"diag_uid": "a5242da840064218638061532405176",
|
||||||
"laneset": [],
|
"laneset": [],
|
||||||
"lanes": [],
|
"lanes": [],
|
||||||
"activities":
|
"activities":
|
||||||
@@ -627,8 +623,8 @@ POST /project/{prj_uid}/diagram/{dia_uid}
|
|||||||
{
|
{
|
||||||
"evn_uid": "960500897525d8eb8fb84b4013700338",
|
"evn_uid": "960500897525d8eb8fb84b4013700338",
|
||||||
"evn_name":null,
|
"evn_name":null,
|
||||||
"evn_type":null,
|
"evn_type":"",
|
||||||
"evn_marker":null,
|
"evn_marker":"",
|
||||||
"evn_is_interrupting":true,
|
"evn_is_interrupting":true,
|
||||||
"evn_attached_to":null,
|
"evn_attached_to":null,
|
||||||
"evn_cancel_activity":false,
|
"evn_cancel_activity":false,
|
||||||
@@ -645,7 +641,7 @@ POST /project/{prj_uid}/diagram/{dia_uid}
|
|||||||
"evn_time_date":null,
|
"evn_time_date":null,
|
||||||
"evn_time_cycle":null,
|
"evn_time_cycle":null,
|
||||||
"evn_time_duration":null,
|
"evn_time_duration":null,
|
||||||
"evn_behavior":null,
|
"evn_behavior":"",
|
||||||
"bou_x":87,
|
"bou_x":87,
|
||||||
"bou_y":261,
|
"bou_y":261,
|
||||||
"bou_width":33,
|
"bou_width":33,
|
||||||
@@ -656,8 +652,8 @@ POST /project/{prj_uid}/diagram/{dia_uid}
|
|||||||
{
|
{
|
||||||
"evn_uid": "941908090525d8ec7fb8a07093841901",
|
"evn_uid": "941908090525d8ec7fb8a07093841901",
|
||||||
"evn_name":null,
|
"evn_name":null,
|
||||||
"evn_type":null,
|
"evn_type":"",
|
||||||
"evn_marker":null,
|
"evn_marker":"",
|
||||||
"evn_is_interrupting":true,
|
"evn_is_interrupting":true,
|
||||||
"evn_attached_to":null,
|
"evn_attached_to":null,
|
||||||
"evn_cancel_activity":false,
|
"evn_cancel_activity":false,
|
||||||
@@ -674,7 +670,7 @@ POST /project/{prj_uid}/diagram/{dia_uid}
|
|||||||
"evn_time_date":null,
|
"evn_time_date":null,
|
||||||
"evn_time_cycle":null,
|
"evn_time_cycle":null,
|
||||||
"evn_time_duration":null,
|
"evn_time_duration":null,
|
||||||
"evn_behavior":null,
|
"evn_behavior":"",
|
||||||
"bou_x":903,
|
"bou_x":903,
|
||||||
"bou_y":303,
|
"bou_y":303,
|
||||||
"bou_width":33,
|
"bou_width":33,
|
||||||
@@ -774,6 +770,8 @@ POST /project/{prj_uid}/diagram/{dia_uid}
|
|||||||
],
|
],
|
||||||
"artifacts": []
|
"artifacts": []
|
||||||
}
|
}
|
||||||
|
]
|
||||||
|
}
|
||||||
< 201
|
< 201
|
||||||
< Content-Type: application/json
|
< Content-Type: application/json
|
||||||
[
|
[
|
||||||
@@ -835,11 +833,17 @@ POST /project/{prj_uid}/diagram/{dia_uid}
|
|||||||
]
|
]
|
||||||
|
|
||||||
|
|
||||||
Update a project `diagram`
|
Update a `project`
|
||||||
PUT /project/{prj_uid}/diagram/{dia_uid}
|
PUT /project/{prj_uid}
|
||||||
> Content-Type: application/json
|
> Content-Type: application/json
|
||||||
{
|
{
|
||||||
"pro_uid": "8061532405176da5242da84006421863",
|
"prj_uid" : "8061532405176da5242da84006421863",
|
||||||
|
"prj_name" : "Sample Project",
|
||||||
|
"prj_description" : "sample desc",
|
||||||
|
"diagrams":
|
||||||
|
[
|
||||||
|
{
|
||||||
|
"diag_uid": "a5242da840064218638061532405176",
|
||||||
"laneset": [],
|
"laneset": [],
|
||||||
"lanes": [],
|
"lanes": [],
|
||||||
"activities":
|
"activities":
|
||||||
@@ -883,8 +887,8 @@ PUT /project/{prj_uid}/diagram/{dia_uid}
|
|||||||
{
|
{
|
||||||
"evn_uid": "960500897525d8eb8fb84b4013700338",
|
"evn_uid": "960500897525d8eb8fb84b4013700338",
|
||||||
"evn_name":null,
|
"evn_name":null,
|
||||||
"evn_type":null,
|
"evn_type":"",
|
||||||
"evn_marker":null,
|
"evn_marker":"",
|
||||||
"evn_is_interrupting":true,
|
"evn_is_interrupting":true,
|
||||||
"evn_attached_to":null,
|
"evn_attached_to":null,
|
||||||
"evn_cancel_activity":false,
|
"evn_cancel_activity":false,
|
||||||
@@ -901,7 +905,7 @@ PUT /project/{prj_uid}/diagram/{dia_uid}
|
|||||||
"evn_time_date":null,
|
"evn_time_date":null,
|
||||||
"evn_time_cycle":null,
|
"evn_time_cycle":null,
|
||||||
"evn_time_duration":null,
|
"evn_time_duration":null,
|
||||||
"evn_behavior":null,
|
"evn_behavior":"",
|
||||||
"bou_x":87,
|
"bou_x":87,
|
||||||
"bou_y":261,
|
"bou_y":261,
|
||||||
"bou_width":33,
|
"bou_width":33,
|
||||||
@@ -912,8 +916,8 @@ PUT /project/{prj_uid}/diagram/{dia_uid}
|
|||||||
{
|
{
|
||||||
"evn_uid": "941908090525d8ec7fb8a07093841901",
|
"evn_uid": "941908090525d8ec7fb8a07093841901",
|
||||||
"evn_name":null,
|
"evn_name":null,
|
||||||
"evn_type":null,
|
"evn_type":"",
|
||||||
"evn_marker":null,
|
"evn_marker":"",
|
||||||
"evn_is_interrupting":true,
|
"evn_is_interrupting":true,
|
||||||
"evn_attached_to":null,
|
"evn_attached_to":null,
|
||||||
"evn_cancel_activity":false,
|
"evn_cancel_activity":false,
|
||||||
@@ -930,7 +934,7 @@ PUT /project/{prj_uid}/diagram/{dia_uid}
|
|||||||
"evn_time_date":null,
|
"evn_time_date":null,
|
||||||
"evn_time_cycle":null,
|
"evn_time_cycle":null,
|
||||||
"evn_time_duration":null,
|
"evn_time_duration":null,
|
||||||
"evn_behavior":null,
|
"evn_behavior":"",
|
||||||
"bou_x":903,
|
"bou_x":903,
|
||||||
"bou_y":303,
|
"bou_y":303,
|
||||||
"bou_width":33,
|
"bou_width":33,
|
||||||
@@ -1030,6 +1034,8 @@ PUT /project/{prj_uid}/diagram/{dia_uid}
|
|||||||
],
|
],
|
||||||
"artifacts": []
|
"artifacts": []
|
||||||
}
|
}
|
||||||
|
]
|
||||||
|
}
|
||||||
< 201
|
< 201
|
||||||
< Content-Type: application/json
|
< Content-Type: application/json
|
||||||
[
|
[
|
||||||
@@ -1091,8 +1097,8 @@ PUT /project/{prj_uid}/diagram/{dia_uid}
|
|||||||
]
|
]
|
||||||
|
|
||||||
|
|
||||||
Delete a project `diagram`
|
Delete a `project`
|
||||||
DELETE /project/{prj_uid}/diagram/{dia_uid}
|
DELETE /project/{prj_uid}
|
||||||
< 200
|
< 200
|
||||||
|
|
||||||
|
|
||||||
@@ -1327,7 +1333,6 @@ DELETE /project/{prj_uid}/activity/{act_uid}/assignee/{aas_uid}
|
|||||||
> Content-Type: application/json
|
> Content-Type: application/json
|
||||||
< 200
|
< 200
|
||||||
|
|
||||||
|
|
||||||
--
|
--
|
||||||
Project Properties - Ad hoc Assignee Resources
|
Project Properties - Ad hoc Assignee Resources
|
||||||
--
|
--
|
||||||
@@ -1645,5 +1650,3 @@ Remove a `trigger` assignation of a Step
|
|||||||
DELETE /project/{prj_uid}/activity/{act_uid}/step/{step_uid}/trigger/{tri_uid}
|
DELETE /project/{prj_uid}/activity/{act_uid}/step/{step_uid}/trigger/{tri_uid}
|
||||||
< 200
|
< 200
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
Reference in New Issue
Block a user