AE REST API - Execution List
Here you can find different examples of how to get lists of executions that fulfill certain criteria.
This page includes the following:
Example 1
Request: GET http://{host}:{port}/ae/api/v1/{client}/executions&type={type}&type={type}&type={type}&...
Example: http://my-jcp-host:8088/ae/api/v1/8001/executions?&type=JOBS&type=SCRI&type=JOBP&type=C_PERIOD&type=CALL
Get all executions that are:
-
still running (include_deactivated=false per default)
-
of object type JOBS, SCRI, JOBP, C_PERIOD, or CALL
HTTP 200 Response:
{
"total": 5,
"data": [
{
"name": "CALL.MAIL.HTML.FILTER",
"type": "CALL",
"run_id": 26350826,
"status": 1900,
"status_text": "ENDED_OK - ended normally",
"runtime": 6,
"activation_time": "2018-04-17T14:39:36Z",
"start_time": "2018-04-17T14:39:36Z",
"end_time": "2018-04-17T14:39:42Z",
"parent": 0,
"user": "SMITH/DEP",
"estimated_runtime": 4,
"alias": "CALL.MAIL.HTML.FILTER"
},
{
"name": "CALL.MAIL.HTML.FILTER",
"type": "CALL",
"run_id": 26350825,
"status": 1900,
"status_text": "ENDED_OK - ended normally",
"runtime": 4,
"activation_time": "2018-04-17T14:39:09Z",
"start_time": "2018-04-17T14:39:09Z",
"end_time": "2018-04-17T14:39:13Z",
"parent": 0,
"user": "SMITH/DEP",
"estimated_runtime": 222,
"alias": "CALL.MAIL.HTML.FILTER"
},
{
"name": "SCRI.FILTER",
"type": "SCRI",
"run_id": 26355183,
"status": 1900,
"status_text": "ENDED_OK - ended normally",
"runtime": 0,
"activation_time": "2018-04-17T13:44:11Z",
"start_time": "2018-04-17T13:44:11Z",
"end_time": "2018-04-17T13:44:11Z",
"parent": 0,
"user": "SMITH/DEP",
"estimated_runtime": 1,
"alias": "SCRI.FILTER"
},
{ "name": "WORKFLOW.DEMO",
"type": "JOBP",
"run_id": 26355156,
"status": 1820,
"status_text": "FAULT_OTHER - Start impossible. Other error.",
"runtime": 0,
"activation_time": "2018-04-17T12:52:36Z",
"end_time": "2018-04-17T12:53:15Z",
"parent": 0,
"user": "SMITH/DEP",
"estimated_runtime": 1,
"alias": "WORKFLOW.DEMO"
},
{
"name": "JOBS.WIN.FILTER",
"type": "JOBS",
"run_id": 26347117,
"status": 1900,
"status_text": "ENDED_OK - ended normally",
"runtime": 0,
"activation_time": "2018-04-17T09:57:25Z",
"start_time": "2018-04-17T09:57:25Z",
"end_time": "2018-04-17T09:57:25Z",
"agent": "WIN_AGENT1",
"platform": "WINDOWS",
"parent": 0,
"user": "SMITH/DEP",
"estimated_runtime": 1,
"alias": "JOBS.WIN.FILTER"
}
],
"hasmore": true
}
Example 2
Request: GET http://{host}:{port}/ae/api/v1/{client}/executions
Example: http://my-jcp-host:8088/ae/api/v1/8001/executions?queue=FAST.QUEUE&agent=WIN_AGENT1&type=JOBS&type=CALL&time_frame_from=2018-05-02T00:00:00Z&time_frame_to=2018-05-02T23:59:59Z&include_deactivated=true
Get all executions:
-
that are running on WIN_AGENT1 and
-
of type JOBS or CALL and
-
with timestamps within 00:00:00 and 23:59:59 on 2nd of May 2018 and
-
either deactivated or still active
Example 3
Request: GET http://{host}:{port}/ae/api/v1/{client}/executions
Example: http://my-jcp-host:8088/ae/api/v1/8001/executions?queue=FAST.QUEUE&type=JOBP&type=CPIT&type=JOBG&status=1900
Get all executions that:
-
are executed in queue FAST.QUEUE and
-
are of type JOBP, CPIT, or JOBG and
-
do have the status 1900 (ENDED_OK) and
-
are either deactivated or
-
still active
Example 4
Request: GET http://{host}:{port}/ae/api/v1/{client}/executions
Example: http://my-jcp-host:8088/ae/api/v1/8001/executions?queue=FAST.QUEUE&type=JOBP,CPIT,JOBG&status=1900
This request is the same as in Example 3, but the types are stated in a more compact way.
Example 5
Request: GET http://{host}:{port}/ae/api/v1/{client}/executions
Example: http://my-jcp-host:8088/ae/api/v1/8001/executions?type=JOBS&status=1800&platform=SQL
Get all executions that:
-
are of type JOBS and
-
are of platform SQL and
-
ended with status 1800 (ENDED_NOT_OK) and
-
are not deactivated yet
Example 6
Get all jobs beginning with PMAWA and ending with FILTER (use of wildcard), of a given platform (WINDOWS) that were deactivated since two days ago.
Example: http://my-jcp-host:8088/ae/api/v1/8001/executions?name=*JOB.*&include_deactivated=true
Get all executions that:
-
match the name pattern *JOB.* and
-
are either deactivated or still active
Request: GET http://{host}:{port}/ae/api/v1/{client}/executions
Example: http://my-jcp-host:8088/ae/api/v1/8001/executions?name=*JOB.*&include_deactivated=true
Get all executions that:
-
match the name pattern *JOB.* and
-
are either deactivated or still active
HTTP 200 Response:
{
"total": 8,
"data": [
{
"name": "PMAWA_10693_JOBS.WIN_FILTER",
"type": "JOBS",
"run_id": 1053022,
"status": 1900,
"status_text": "ENDED_OK - ended normally",
"runtime": 0,
"activation_time": "2018-04-16T15:09:15Z",
"start_time": "2018-04-16T15:09:46Z",
"end_time": "2018-04-16T15:09:46Z",
"agent": "WIN_AGENT1",
"platform": "WINDOWS",
"parent": 1054044,
"user": "SMITH/DEP",
"estimated_runtime": 1,
"title": "JOBS.WIN_RECURRING",
"alias": "PMAWA_10693_JOBS.WIN_FILTER_ALIAS"
},
{
"name": "PMAWA_10693_JOBS.WIN_FILTER",
"type": "JOBS",
"run_id": 1052023,
"status": 1900,
"status_text": "ENDED_OK - ended normally",
"runtime": 0,
"activation_time": "2018-04-16T15:08:14Z",
"start_time": "2018-04-16T15:08:45Z",
"end_time": "2018-04-16T15:08:45Z",
"agent": "WIN_AGENT1",
"platform": "WINDOWS",
"parent": 1054044,
"user": "SMITH/DEP",
"estimated_runtime": 1,
"title": "JOBS.WIN_RECURRING",
"alias": "PMAWA_10693_JOBS.WIN_FILTER_ALIAS"
},
{
"name": "PMAWA_10693_JOBS.WIN_FILTER",
"type": "JOBS",
"run_id": 1053021,
"status": 1900,
"status_text": "ENDED_OK - ended normally",
"runtime": 0,
"activation_time": "2018-04-16T15:07:14Z",
"start_time": "2018-04-16T15:07:45Z",
"end_time": "2018-04-16T15:07:45Z",
"agent": "WIN_AGENT1",
"platform": "WINDOWS",
"parent": 1054044,
"user": "SMITH/DEP",
"estimated_runtime": 1,
"title": "JOBS.WIN_RECURRING",
"alias": "PMAWA_10693_JOBS.WIN_FILTER_ALIAS"
},
{
"name": "PMAWA_10693_JOBS.WIN_FILTER",
"type": "JOBS",
"run_id": 1052022,
"status": 1900,
"status_text": "ENDED_OK - ended normally",
"runtime": 0,
"activation_time": "2018-04-16T15:06:14Z",
"start_time": "2018-04-16T15:06:44Z",
"end_time": "2018-04-16T15:06:44Z",
"agent": "WIN_AGENT1",
"platform": "WINDOWS",
"parent": 1054044,
"user": "SMITH/DEP",
"estimated_runtime": 1,
"title": "JOBS.WIN_RECURRING",
"alias": "PMAWA_10693_JOBS.WIN_FILTER_ALIAS"
},
{
"name": "PMAWA_10693_JOBS.WIN_FILTER",
"type": "JOBS",
"run_id": 1052021,
"status": 1900,
"status_text": "ENDED_OK - ended normally",
"runtime": 0,
"activation_time": "2018-04-16T15:05:14Z",
"start_time": "2018-04-16T15:05:45Z",
"end_time": "2018-04-16T15:05:45Z",
"agent": "WIN_AGENT1",
"platform": "WINDOWS",
"parent": 1054044,
"user": "SMITH/DEP",
"estimated_runtime": 1,
"title": "JOBS.WIN_RECURRING",
"alias": "PMAWA_10693_JOBS.WIN_FILTER_ALIAS"
},
{
"name": "PMAWA_10693_JOBS.WIN_FILTER",
"type": "JOBS",
"run_id": 1052020,
"status": 1900,
"status_text": "ENDED_OK - ended normally",
"runtime": 0,
"activation_time": "2018-04-16T15:04:15Z",
"start_time": "2018-04-16T15:04:46Z",
"end_time": "2018-04-16T15:04:46Z",
"agent": "WIN_AGENT1",
"platform": "WINDOWS",
"parent": 1054044,
"user": "SMITH/DEP",
"estimated_runtime": 1,
"title": "JOBS.WIN_RECURRING",
"alias": "PMAWA_10693_JOBS.WIN_FILTER_ALIAS"
},
{
"name": "PMAWA_10693_JOBS.WIN_FILTER",
"type": "JOBS",
"run_id": 1053019,
"status": 1900,
"status_text": "ENDED_OK - ended normally",
"runtime": 0,
"activation_time": "2018-04-16T15:03:14Z",
"start_time": "2018-04-16T15:03:46Z",
"end_time": "2018-04-16T15:03:46Z",
"agent": "WIN_AGENT1",
"platform": "WINDOWS",
"parent": 1054044,
"user": "SMITH/DEP",
"estimated_runtime": 1,
"title": "JOBS.WIN_RECURRING",
"alias": "PMAWA_10693_JOBS.WIN_FILTER_ALIAS"
},
{
"name": "PMAWA_10693_JOBS.WIN_FILTER",
"type": "JOBS",
"run_id": 1054054,
"status": 1900,
"status_text": "ENDED_OK - ended normally",
"runtime": 0,
"activation_time": "2018-04-16T15:02:14Z",
"start_time": "2018-04-16T15:02:45Z",
"end_time": "2018-04-16T15:02:45Z",
"agent": "WIN_AGENT1",
"platform": "WINDOWS",
"parent": 1054044,
"user": "SMITH/DEP",
"estimated_runtime": 1,
"title": "JOBS.WIN_RECURRING",
"alias": "PMAWA_10693_JOBS.WIN_FILTER_ALIAS"
}
],
"hasmore": false
}
See also: