Skip to main content

Export Application API

Export Application API Integration Guide


Path: /flow/v2/exports/applications

Method: GET

NAMEVALUE
AuthorizationBearer < your access-token >

Query Parameters

NAMEDESCRIPTIONEXAMPLE
appKey*Restrict to applications that belong to a process definition with the given key.quickEvaluation
startTime*Restrict to applications that were started after the given date. By default, the date must have the format yyyy-MM-dd'T'HH:mm:ss.SSSZ, e.g., 2013-01-23T14:42:45.000Z.2020-04-10T09:45:02.826Z
endTime*Restrict to applications that were started before the given date. By default, the date must have the format yyyy-MM-dd'T'HH:mm:ss.SSSZ, e.g., 2013-01-23T14:42:45.000Z.2020-08-25T09:45:02.826Z
status"active" - Restrict to instances that are active.
"completed" - Restrict to instances that are completed
active
-* Required query parameters.-

Note: The maximum interval that can be queried is 24 hours.

Result

A JSON array that includes requested applications with the following properties:

NAMEDescription
idThe application id
versionThe version of the process definition that this application belongs to.
dataA JSON object of variables key-value pairs. Each key is a variable name, and each value is a variable value object that has the following properties:
value - The variable's value.
type - The value type of the variable.
valueInfo - Additional information that required for the variable's value.
statusThe status of the application, possible values are: ACTIVE - running application, COMPLETED - completed application.
createdAtThe time the application was created. Default format: yyyy-MM-dd'T'HH:mm:ss.SSSZ.
updatedAtThe time the application was updated. Default format: yyyy-MM-dd'T'HH:mm:ss.SSSZ.

Example

{
"applications": [
{
"id": "018b1e7b-ca6a-11ea-a6ce-12cb1cdfff18",
"version": 4,
"data": {
"startedBy": {
"type": "String",
"value": "superAdmin"
},
"age": {
"type": "Integer",
"value": 42
},
"fileVar": {
"type": "Object",
"value": "{\"contentType\":\"image/png\",\"url\":\"https://storage.googleapis.com/xxx/694d3529-0137-4bfc-b3a4-9fb2a2c98b94\",\"fileName\":\"node-arch.png\"}",
"valueInfo": {
"objectTypeName": "com.google.gson.JsonObject",
"serializationDataFormat": "application/json"
}
}
},
"status": "ACTIVE",
"createdAt": "2020-07-20T09:18:42.946Z",
"updatedAt": "2020-08-06T16:01:46.363Z"
},
{
"id": "113c4cfc-ca6a-11ea-a6ce-12cb1cdfff18",
"version": 4,
"data": {
"StartprocessGeolocation": {
"type": "String",
"value": "{\"user\":\"superAdmin\",\"coords\":{\"latitude\":13.082680199999999,\"longitude\":80.2707184,\"altitude\":null,\"accuracy\":520488,\"altitudeAccuracy\":null,\"heading\":null,\"speed\":null},\"locationName\":\"Poongavanapuram, Chennai\",\"timeStamp\":1593502900207,\"date\":\"2020-06-30T07:41:40.729Z\"}"
},
"startedBy": {
"type": "String",
"value": "superAdmin"
}
},
"status": "COMPLETED",
"createdAt": "2020-07-20T09:19:09.273Z",
"updatedAt": "2020-07-20T09:21:09.273Z"
}
]
}