You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 39 Next »

Definition

App API can perform many app-level functions.

The options here is based on the current app context.


NameDescription
1

Add environment variable

Add a new environment variable to the current app.

Name

Description
URL/app/environment
HTTP MethodPOST
Body Parameters
ParameterDescription
idEnvironment variable ID.
valueEnvironment variable value.
remarksDescription of environment variable.
Sample Response
{
  "value": "I exist via API.",
  "remarks": "This is an environment variable created with API Builder.",
  "id": "apiEnvVar"
}
2

Create new version

Create a new app version based on the specified version of the current app.

Name

Description
URL/app/new/{version}
HTTP MethodPOST
Path Parameters
ParameterDescription
versionVersion of current app to base on. Expects an integer value.
Sample Response
{
  "published": false,
  "description": null,
  "meta": null,
  "id": "expenseclaim",
  "version": 2,
  "name": "Expenses Claim",
  "dateCreated": "Aug 26, 2019 4:37:19 PM",
  "dateModified": "Aug 26, 2019 4:37:22 PM"
}
3Delete environment variable

Delete the specified environment variable in the current app.

Name

Description
URL/app/environment/{id}
HTTP MethodDELETE
Path Parameters
ParameterDescription
idID of environment variable to remove. Expects a string.
Sample Response
{
  "date": "Mon Aug 26 16:57:53 SGT 2019",
  "code": "200",
  "message": "Successful operation"
}
4Delete version

Delete the specified app version of the current app.

Name

Description
URL/app/delete/{version}
HTTP MethodDELETE
Path Parameters
ParameterDescription
versionVersion of current app to remove. Expects an integer value.
Sample Response
{
  "date": "Mon Aug 26 17:02:35 SGT 2019",
  "code": "200",
  "message": "Successful operation"
}
5Deploy XPDL

Deploy a XPDL file as a new/updated process design to the current app.

Name

Description
URL/app/deploy/xpdl
HTTP MethodPOST
Body Parameters
ParameterDescription
FileExpects a XPDL file.
Sample Response
{
  "date": "Mon Aug 26 18:17:30 SGT 2019",
  "code": "200",
  "message": "Successful operation"
}
6Download XPDL

Download the process definition of all process(es) as XPDL file.

Name

Description
URL/app/xpdl
HTTP MethodGET
Parameters

-

Sample Response

Definition of all process(es) as XPDL.

7Download addon builder definition

Download the specified addon builder JSON definition.

Name

Description
URL/app/{builder}/definition/{id}
HTTP MethodGET
Path Parameters
ParameterDescription
builderBuilder's ID. (e.g: "design" for API Builder)
idBuilder page ID.
Sample Response
{
  "properties": {
    "id": "API-5bc8e093-00cd-455a-a6b0-d94aa92a446f",
    "name": "Test",
    "description": "Test ALL APIs."
  },
  "elements": [
    {
      "className": "org.joget.api.lib.AppAPI",
      "properties": {
        "id": "0DA51715-7FD1-465D-98A0-7B73AABD037F",
        "ENABLED_PATHS": "get:/{builder}/definition/{id}"
      }
    }
  ]
}
8Download datalist definition

Download the specified datalist JSON definition.

Name

Description
URL/app/datalist/definition/{id}
HTTP MethodGET
Path Parameters
ParameterDescription


Sample Response


9Download form definition


Download the specified form JSON definition.


Name
Description
URL/app/form/definition/{id}
HTTP MethodGET
Path Parameters
ParameterDescription


Sample Response




10Download userview definition


Download the specified userview JSON definition.


Name
Description
URL/app/userview/definition/{id}
HTTP MethodGET
Path Parameters
ParameterDescription


Sample Response




11Find environment variable


Get values of all environment variable(s) in the current app by default. Able to filter or sort the returned results via parameters.


Name
Description
URL/app/environment/find
HTTP MethodGET
Path Parameters
ParameterDescription


Sample Response




12Get environment variable by ID


Get values of an environment variable by its specified ID.


Name
Description
URL/app/environment/{id}
HTTP MethodGET
Path Parameters
ParameterDescription


Sample Response




13Increase environment variable counter value


Increments the specified environment variable counter value by 1.


Name
Description
URL/app/environment/increaseCounter
HTTP MethodPUT
Path Parameters
ParameterDescription


Sample Response




14List created addon builder element


List ID of all created addon builder element(s) present in the current app.


Name
Description
URL/app/list/{builder}
HTTP MethodGET
Path Parameters
ParameterDescription


Sample Response




15List created datalist


List ID of all created datalist(s) present in the current app.


Name
Description
URL/app/list/datalist
HTTP MethodGET
Path Parameters
ParameterDescription


Sample Response




16List created form


List ID of all created form(s) present in the current app.


Name
Description
URL/app/list/form
HTTP MethodGET
Path Parameters
ParameterDescription


Sample Response




17List created userview


List ID of all created userview(s) present in the current app.


Name
Description
URL/app/list/userview
HTTP MethodGET
Path Parameters
ParameterDescription


Sample Response




18List versions


List ID of all created app version(s) of the current app.


Name
Description
URL/app/versions
HTTP MethodGET
Path Parameters
ParameterDescription


Sample Response




19Published version


Get the currently published app version of the current app.


Name
Description
URL/app/published
HTTP MethodGET
Path Parameters
ParameterDescription


Sample Response




20Retrieve created addon builder element as options


List label & value of all addon builder element(s) present in the current app.


Name
Description
URL/app/{builder}/options
HTTP MethodGET
Path Parameters
ParameterDescription


Sample Response




21Retrieve created datalist as options


List label & value of all datalist(s) present in the current app.


Name
Description
URL/app/datalist/options
HTTP MethodGET
Path Parameters
ParameterDescription


Sample Response




22Retrieve created form as options


List label & value of all form(s) present in the current app.


Name
Description
URL/app/form/options
HTTP MethodGET
Path Parameters
ParameterDescription


Sample Response




23Retrieve created userview as options


List label & value of all userview(s) present in the current app.


Name
Description
URL/app/userview/options
HTTP MethodGET
Path Parameters
ParameterDescription


Sample Response




24Retrieve processes as options


List label & value of all process(es) present in the current app.


Name
Description
URL/app/process/options
HTTP MethodGET
Path Parameters
ParameterDescription


Sample Response




25Update environment variable


Update the value of an environment variable in the current app.


Name
Description
URL/app/environment
HTTP MethodPUT
Path Parameters
ParameterDescription


Sample Response









                
        
    
        


                        
    





    

	

		
    
    
            
  • 
            No labels
        
    •