3.2 - 3.8 - REST API Designer - Case Tracker

Case Tracker

The current methods implemented for the case tracker in the ProcessMaker API designer are listed below:

Case Tracker:

Name	Description	Type	Value
map_type	Map type	String	"NONE", "PROCESSMAP", "STAGES" (unique values)
routing_history	Routing history	Integer	0,1 (unique values)
messages_history	Message history	Integer	0,1 (unique values)
cto_uid	Case tracker object UID	String	"9541049475298f190420f51086854718” (String of 32 characters)
cto_type_obj*	Object type	String	"DYNAFORM", "INPUT_DOCUMENT", "OUTPUT_DOCUMENT" (unique values)
cto_uid_obj*	Object UID	String	"9541049475298f190420f51086854718” (String of 32 characters)
cto_condition	Case tracker object condition, the object is only available if the condition evaluates to true	String	"@@YEAR==2014"
cto_position	Position that specifies the order of deployment. Starts at 1.	Integer	1,2...
obj_uid	Object UID	String	"9541049475298f190420f51086854718” (String of 32 characters)
obj_title	Object title	String	"Title..."
obj_description	Object description	String	"Description..."
obj_type	Object type	String	"DYNAFORM", "INPUT_DOCUMENT","OUTPUT_DOCUMENT" (unique values)

Note: cto_type_obj and cto_uid_obj are dependent variables, thus, if one of them is sent the other must be sent.

Get Case Tracker Properties: GET project/{prj_uid}/case-tracker/property

Gets the properties of a Case Tracker.

GET /api/1.0/{workspace}/project/{prj_uid}/case-tracker/property

Parameters:

Name	Type	Description
workspace	String	Workspace name
prj_uid	String	Project UID

Result:

Type	Description
array	Returns an array of objects contaning data about the Case Tracker

Example:

Response

Update Case Tracker: PUT project/{prj_uid}/case-tracker/property

Updates a Case Tracker.

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}/case-tracker/property

Parameters:

Name	Type	Description
workspace	String	Workspace name
prj_uid	String	Project UID

Optional Fields:

Name	Type	Description
map_type	String	Map type
routing_history	Integer	Routing history
messages_history	Integer	Messages history

Result:

Type	Description
empty	No return

Example:

Request

Response

Case Tracker Objects List: GET project/{prj_uid}/case-tracker/objects

Gets a list of Case Tracker objects in a project.

GET /api/1.0/{workspace}/project/{prj_uid}/case-tracker/objects

Parameters:

Name	Type	Description
workspace	String	Workspace name
prj_uid	String	Project UID

Result:

Type	Description
array	Returns an object array containing data about each Case Tracker object in the project.

Example:

Response

Available Case Tracker Objects: GET project/{prj_uid}/case-tracker/available-objects

Gets a list of the available Case Tracker objects in a project.

GET /api/1.0/{workspace}/project/{prj_uid}/case-tracker/available-objects

Parameters:

Name	Type	Description
workspace	String	Workspace name
prj_uid	String	Project UID

Result:

Type	Description
array	Returns an object array contaning data about each object available for the project.

Example:

Response

Get Case Tracker Object: GET project/{prj_uid}/case-tracker/object/{cto_uid}

Gets a specified Case Tracker object.

GET /api/1.0/{workspace}/project/{prj_uid}/case-tracker/object/{cto_uid}

Parameters:

Name	Type	Description
workspace	String	Workspace name
prj_uid	String	Project UID
cto_uid	String	Case tracker object UID

Result:

Type	Description
object	Returns an object containing the Case Tracker object data

Example:

Response

Assign Case Tracker Object: POST project/{prj_uid}/case-tracker/object

Assigns an object (Dynaform, Input Document, Output Document) to a case tracker.

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}/case-tracker/object

Parameters:

Name	Type	Description
workspace	String	Workspace name
prj_uid	String	Project UID

Optional Fields:

Name	Type	Description
cto_type_obj	String	If cto_type_obj was sent, it is necessary to send cto_uid_obj
cto_uid_obj	String	If cto_uid_obj was sent, it is necessary to send cto_type_obj
cto_condition	String	Case tracker condition
cto_position	String	Position that specifies the order of deployment. Starts on 1.
obj_uid	String	Object UID
obj_title	String	Object title
obj_description	String	Object description
obj_type	String	Object type

Result:

Type	Description
object	Returns an object containing the Case Tracker Object data, plus "cto_uid"

Example:

Request

Response

Update Case Tracker Object: PUT project/{prj_uid}/case-tracker/object/{cto_uid}

Updates an object in a case tracker.

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}/case-tracker/object/{cto_uid}

Parameters:

Name	Type	Description
workspace	String	Workspace name
prj_uid	String	Project UID
cto_uid	String	Case tracker object UID

Optional Fields:

Name	Type	Description
cto_type_obj	String	If cto_type_obj was sent, it is necessary to send cto_uid_obj
cto_uid_obj	String	If cto_uid_obj was sent, it is necessary to send cto_type_obj
cto_condition	String	Case tracker condition
cto_position	String	Position that specifies the order of deployment. Starts on 1.
obj_uid	String	Object UID
obj_title	String	Object title
obj_description	String	Object description
obj_type	String	Object type

Result:

Type	Description
empty	No return

Example:

Request

Response

Delete Case Tracker Object: DELETE project/{prj_uid}/case-tracker/object/{cto_uid}

Deletes a Case Tracker object.

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}/case-tracker/object/{cto_uid}

Parameters:

Name	Type	Description
workspace	String	Workspace name
prj_uid	String	Project UID
cto_uid	String	Case tracker object UID

Result:

Type	Description
empty	No return

Example:

Response