Using the AE REST API
The AE REST API provides many different endpoints. Here you can find numerous real-life examples to guide you through these endpoints.
This page includes the following:
Get Swagger Documentation
You can get the swagger based REST API documentation by sending a request via web browser to display the readable response. For more information, see REST API Reference.
Request: The AE REST API Reference documentation can be requested in three different formats:
-
GET http://{host}:{port}/ae/api/v1 or http://{host}:{port}/ae/api/v1/openapi2/index.html
-
GET http://{host}:{port}/ae/api/v1/openapi2/swagger.json
-
GET http://{host}:{port}/ae/api/v1/openapi2/swagger.yaml
Example: http://my-jcp-host:8088/ae/api/v1
HTTP 200 Response: The swagger-based API reference in the requested format.
Health Checks
Ping Health Check
Check if the JCP/AE REST API is available to send subsequent request.
Request: GET http:{host}:{port}/ae/api/v1/ping
Notes:
-
No client information needed in the URI
-
No AE credentials/basic authentication needed
Example: http://my-jcp-host:8088/ae/api/v1/ping
HTTP 200 Response: No payload.
System Health Check
Get system information from AE or check if the JCP/REST API is available.
Request: GET http:{host}:{port}/ae/api/v1/{client}/system/health
Example: http://my-jcp-host:8088/ae/api/v1/8001/system/health
HTTP 200 Response:
{
"status": "UP",
"pwp": {
"status": "UP",
"instancesRunning": 1
},
"jwp": {
"status": "UP",
"instancesRunning": 1
},
"cp": {
"status": "UP",
"instancesRunning": 4
}
}
Specific Workflow Search
Search for specific workflow "WORKFLOW.DEMO" through Advanced Searchwith:
-
object_name = name pattern "*FLOW*"
-
location = root folder
-
include_subfolders = all AE folders
-
max_results = limit result set to 20 entries
Request: POST http://{host}:{port}/ae/api/v1/{client}/search
Example:http://my-jcp-host:8088/ae/api/v1/8001/search
{
"filters": [{
"filter_identifier": "object_name",
"object_name": "*FLOW*"
}, {
"filter_identifier": "location",
"location": "\\",
"include_subfolders": true
}],
"max_results": 20
}
HTTP 200 Response:
{
"data": [
{
"name": "PRPT.WORKFLOW.1",
"type": "PRPT",
"id": "38785339",
"title": null,
"archive_key1": null,
"archive_key2": null,
"folder_path": "\\AE_REST_API\\GENERAL",
"folder_id": "38785363",
"modified_date": 1523952080000,
"last_used_date": null,
"link": false,
"score": 0.43229827,
"calendar_keyword_name": null,
"calendar_keyword_ctype": null,
"calendar_keyword_valid_from": null,
"calendar_keyword_valid_to": null,
"calendar_keyword_child_calendar_names": [],
"creation_date": 1523952080000
},
{
"name": "PRPT.WORKFLOW.2",
"type": "PRPT",
"id": "38785338",
"title": null,
"archive_key1": null,
"archive_key2": null,
"folder_path": "\\AE_REST_API\\GENERAL",
"folder_id": "38785363",
"modified_date": 1523952080000,
"last_used_date": null,
"link": false,
"score": 0.43229827,
"calendar_keyword_name": null,
"calendar_keyword_ctype": null,
"calendar_keyword_valid_from": null,
"calendar_keyword_valid_to": null,
"calendar_keyword_child_calendar_names": [],
"creation_date": 1523952080000
}, {
"name": "WORKFLOW.DEMO",
"type": "JOBP",
"id": "38785337",
"title": null,
"archive_key1": null,
"archive_key2": null,
"folder_path": "\\AE_REST_API\\GENERAL",
"folder_id": "38785363",
"modified_date": 1523952080000,
"last_used_date": null,
"link": false,
"score": 0.43229827,
"calendar_keyword_name": null,
"calendar_keyword_ctype": null,
"calendar_keyword_valid_from": null,
"calendar_keyword_valid_to": null,
"calendar_keyword_child_calendar_names": [],
"creation_date": 1523952079000
}
],
"total": 3,
"hasmore": false,
"update_timestamp": 1523966347100
}
Get Expected Input
Get variables of PromptSet assigned to the workflow.
Request: GET http://{host}:{port}/ae/api/v1/{client}/objects/{object name}/inputs
Example: http://my-jcp-host:8088/ae/api/v1/8001/objects/WORKFLOW.DEMO/inputs
HTTP 200 Response:
{
"PRPT.WORKFLOW.2": {
"NUMBER100#": "0",
"TEXT100#": null
},
"PRPT.WORKFLOW.1": {
"TEXT1#": null,
"RADIOGROUP1#": null,
"CHECKBOX1#": [],
"COMBOBOX1#": null,
"NUMBER1#": "0",
"DATETIME1#": "171214"
}
}
Execute Workflow
Request: POST http://{host}:{port}/ae/api/v1/{client}/executions
Example:http://my-jcp-host:8088/ae/api/v1/8001/executions
Immediately
Execute the workflow immediately and pass input variables (PromptSet variables) with an alias name.
{
"object_name": "WORKFLOW.DEMO",
"alias": "WORKFLOW.DEMO.ALIAS",
"inputs":
{
"TEXT1#": "passed text",
"NUMBER1#": "1234",
"COMBOBOX1#": "ANALYTICS",
"RADIOGROUP1#": "Simple Rule",
"CHECKBOX1#": ["ITPA Shared", "Simple Rule"],
"DATETIME1#": "170730",
"TEXT100#": "first passed line\nsecond passed line",
"NUMBER100#": "7777"
}
}
HTTP 200 Response:
{
"run_id": 26350635
}
Once
{
"object_name": "SCRI.ONCE",
"execution_option": "once",
"alias": "MYSCRI.ONCE",
"timezone": "TZ.PEPI1",
"queue": "FAST.QUEUE",
"inputs":
{
"NUMBER1#": "8888",
"TEXT1#": "passed text"
},
"once":
{
"wait_for_manual_release": "false",
"execution_date_time": "2018-02-27T10:00:00Z",
"use_logical_time": "2018-05-03T10:30:00Z"
}
}
HTTP 200 Response:
{
"run_id": 26350635
}
Recurring
{
"object_name": "SCRI.RECURRING",
"alias": "SCRI.RECURRING.ALIAS.P2",
"timezone": "TZ.MY",
"queue": "FAST.QUEUE",
"execution_option": "recurring",
"inputs":
{
"NUMBER1#": "3333",
"TEXT1#": "passed text"
},
"recurring":
{
"start_date": "2016-03-18",
"end_after_executions": "5",
"execute_interval": "000:01",
"between_start": "00:00",
"between_end": "23:59",
"allow_one_overlap": "false",
"adjust_start_time": "true"
}
}
HTTP 200 Response:
{
"run_id": 26350635
}
Monitor Workflow Execution
Monitor workflow execution including alias, archive keys, title, estimated runtime.
Request: GET http://{host}:{port}/ae/api/v1/{client}/executions/{run id}
Example: http://my-jcp-host:8088/ae/api/v1/8001/executions/26355155
HTTP 200 Response:
{
"name": "SCRI.1",
"type": "SCRI",
"run_id": 26355155,
"status": 1900,
"status_text": "ENDED_OK - ended normally",
"runtime": 0,
"activation_time": "2018-04-17T12:51:06Z",
"start_time": "2018-04-17T12:51:06Z",
"end_time": "2018-04-17T12:51:06Z",
"parent": 0,
"user": "SMITH/DEP",
"estimated_runtime": 0,
"archive_key1": "myvalue1",
"archive_key2": "myvalue2",
"title": "MyTitle",
"alias": "MY.ALIAS"
}
Monitor Children Executions of a Workflow
Monitor children executions of a workflow including alias, archive keys, title, estimated runtime.
Without Pagination
Request: GET http://{host}:{port}/ae/api/v1/{client}/executions/{run id}/children
HTTP 200 Response:
{
"total": 3,
"data": [
{
"name": "SCRI1",
"type": "SCRI",
"run_id": 26352285,
"status": 1900,
"status_text": "ENDED_OK - ended normally",
"runtime": 0,
"activation_time": "2018-04-17T12:54:50Z",
"start_time": "2018-04-17T12:54:50Z",
"end_time": "2018-04-17T12:54:50Z",
"parent": 26352284,
"user": "SMITH/DEP",
"estimated_runtime": 0,
"alias": "SCRI1"
},
{
"name": "SCRI3",
"type": "SCRI",
"run_id": 26352287,
"status": 1900,
"status_text": "ENDED_OK - ended normally",
"runtime": 0,
"activation_time": "2018-04-17T12:54:50Z",
"start_time": "2018-04-17T12:54:50Z",
"end_time": "2018-04-17T12:54:50Z",
"parent": 26352284,
"user": "SMITH/DEP",
"estimated_runtime": 1,
"alias": "SCRI3"
},
{
"name": "SCRI2",
"type": "SCRI",
"run_id": 26352286,
"status": 1900,
"status_text": "ENDED_OK - ended normally",
"runtime": 0,
"activation_time": "2018-04-17T12:54:50Z",
"start_time": "2018-04-17T12:54:50Z",
"end_time": "2018-04-17T12:54:50Z",
"parent": 26352284,
"user": "SMITH/DEP",
"estimated_runtime": 1,
"alias": "SCRI2"
}
],
"hasmore": true
}
With Pagination
This request includes pagination information through the query parameters.
Request: GET http://{host}:{port}/ae/api/v1/{client}/executions/{run id}/children?max_results={integer}&start_at_run_id={run id}
-
max_results = limit of resultset entries returned
-
start_at_run_id = run id of the execution of the last requested page
so this requested page returns executions with run id > start_at_run_id
Example: http://my-jcp-host:8088/ae/api/v1/8001/executions/23021234/children?max_results=1&start_at_run_id=263522
HTTP 200 Response:
{
"total": 3,
"data": [
{
"name": "SCRI3",
"type": "SCRI",
"run_id": 26352287,
"status": 1900,
"status_text": "ENDED_OK - ended normally",
"runtime": 0,
"activation_time": "2018-04-17T12:54:50Z",
"start_time": "2018-04-17T12:54:50Z",
"end_time": "2018-04-17T12:54:50Z",
"parent": 26352284,
"user": "SMITH/DEP",
"estimated_runtime": 1,
"alias": "SCRI3"
},
],
"hasmore": true
}
Get Object Variables of Workflow Executions
Exclusively
Request: GET http://{host}:{port}/ae/api/v1/{client}/executions/{run id}/variables
Example: http://my-jcp-host:8088/ae/api/v1/8001/executions/23021234/variables
HTTP 200 Response:
{
"VAR1#": "any text value",
"VAR2#": "0000000000002345"
}
Part of Execution Information
Request: GET http://{host}:{port}/ae/api/v1/{client}/executions/{run id}?fields=variables
Example: http://my-jcp-host:8088/ae/api/v1/8001/executions/23021234?fields=variables
HTTP 200 Response:
The object variables are listed within the sub-structure Variables at the bottom of the response.
{
"name": "SCRI.WITH.VARIABLES",
"type": "SCRI",
"run_id": 26355159,
"status": 1900,
"status_text": "ENDED_OK - ended normally",
"runtime": 0,
"activation_time": "2018-04-17T12:57:08Z",
"start_time": "2018-04-17T12:57:08Z",
"end_time": "2018-04-17T12:57:08Z",
"parent": 0,
"user": "SMITH/DEP",
"estimated_runtime": 1,
"alias": "SCRI.WITH.VARIABLES",
"variables": {
"VAR1#": "any text value",
"VAR2#": "0000000000002345"
}
}
Get Comment on Workflow Execution
Exclusively
Request: GET http://{host}:{port}/ae/api/v1/{client}/executions/{run id}/comments
HTTP 200 Response:
[
{
"timestamp": "2018-04-17T13:03:35Z",
"comment": "My first comment",
"user": "SMITH/DEP"
},
{
"timestamp": "2018-04-17T13:04:08Z",
"comment": "My second even better comment subsequently added",
"user": "SMITH/DEP"
}
]
Part of Execution Information
Request: GET http://{host}:{port}/ae/api/v1/{client}/executions/{run id}?fields=comments
Example: http://my-jcp-host:8088/ae/api/v1/8001/executions/23021234?fields=comments
HTTP 200 Response:
{
"name": "SCRI.WITH.VARIABLES",
"type": "SCRI",
"run_id": 26355159,
"status": 1900,
"status_text": "ENDED_OK - ended normally",
"runtime": 0,
"activation_time": "2018-04-17T12:57:08Z",
"start_time": "2018-04-17T12:57:08Z",
"end_time": "2018-04-17T12:57:08Z",
"parent": 0,
"user": "SMITH/DEP",
"estimated_runtime": 1,
"alias": "SCRI.WITH.VARIABLES",
"comments": [
{
"timestamp": "2018-04-17T13:03:35Z",
"comment": "My first comment",
"user": "SMITH/DEP"
},
{
"timestamp": "2018-04-17T13:04:08Z",
"comment": "My second even better comment subsequently added",
"user": "SMITH/DEP"
}
]
}
Add Comment on Workflow Execution
Request: POST http://{host}:{port}/ae/api/v1/{client}/executions/{run id}/comments
Example: http://my-jcp-host:8088/ae/api/v1/8001/executions/23021234/comments
{
"comment": "This is a comment posted via AE REST API"
}
HTTP 200 Response:
{
"timestamp": "2018-04-17T13:08:01Z",
"comment": "This is a comment posted via AE REST API",
"user": "SMITH/DEP"
}
Get Report List of Workflow Execution
Request: GET http://{host}:{port}/ae/api/v1/{client}/executions/{run id}/reports
Example: http://my-jcp-host:8088/ae/api/v1/8001/executions/23021234/reports
HTTP 200 Response:
[
{
"end_timestamp": "2018-04-17T13:11:54Z",
"type": "ACT",
"is_db": true
},
{
"end_timestamp": "2018-04-17T13:11:54Z",
"type": "POST",
"is_db": true
},
{
"end_timestamp": "2018-04-17T13:11:54Z",
"type": "REP",
"is_db": true
}
]
Get Content of Specific Report
Without Pagination
Request: GET http://{host}:{port}/ae/api/v1/{client}/executions/{run id}/reports/{report type}
Based on the previous response, the report types available are ACT, POST, and REP. These types are used subsequently to request their reports contents.
Example: http://my-jcp-host:8088/ae/api/v1/8001/executions/26350688/reports/REP
HTTP 200 Response:
Reports (report content) are organized in multiple pages whereof the number of report pages depends on the overall size of the whole report. Each report page itself consists of multiple lines of report text. The report pages in the response represent the same portions as stored in the DB.
{
"total": 1,
"data": [
{
"page": 1,
"content": "\r\nc:\\>C:\\Automic\\V12\\Agents\\UC2TS_WIN_MEH\\Bin\\UCXJWX6M.EXE JNR=0026350688 MNR=8001 PNR=2388 IPA=10.243.20.74 TYP=S TXT=\" Job started\" \r\nProgram 'UC4
Job Messenger' version '12.2.0+low.build.1014' started\r\nUCMDJP: *********************************************************************\r\nUCMDJP: ** JOB 0026350688 (ProcID:0000014160) START
AT 17.04.2018/15:11:54 **\r\nUCMDJP: ** UTC TIME 17.04.2018/13:11:54 **\r\nUCMDJP: ** ---------------------------------------------------------------
**\r\nUCMDJP: ** USED: 0.000 CPU **\r\nUCMDJP: *********************************************************************\r\nProgram 'UC4 Job
Messenger' version '12.2.0+low.build.1014' terminated normally\r\n\r\nc:\\>dir c: \r\n Volume in drive C is Windows\r\n Volume Serial Number is 5400-7BCD\r\n\r\n Directory of
c:\\\r\n\r\n22.01.2018 12:05 <DIR> APIRegtests\r\n02.11.2016 18:51 <DIR> app\r\n15.11.2017 16:09 <DIR> Automic\r\n09.03.2018 09:50 <DIR>
Data\r\n24.10.2016 11:48 <DIR> DRIVERS\r\n10.10.2017 14:13 <DIR> eclipse\r\n16.01.2018 12:22 <DIR> image\r\n20.10.2016 15:25 <DIR>
Intel\r\n08.03.2018 15:47 <DIR> logs\r\n22.03.2017 15:43 <DIR> Music\r\n14.07.2009 05:20 <DIR> PerfLogs\r\n11.01.2018 15:41 <DIR> Program
Files\r\n11.01.2018 15:39 <DIR> Program Files (x86)\r\n22.01.2018 12:19 <DIR> Q12S3\r\n07.04.2017 12:01 <DIR> Ruby23-x64\r\n12.01.2018 16:50 <DIR>
share\r\n03.07.2016 02:52 8.196 smsbootsect.bak\r\n20.10.2016 15:00 <DIR> Symbols\r\n27.09.2017 11:17 <DIR> TaskManagerForDev\r\n17.04.2018 12:27
<DIR> Temp\r\n18.01.2018 10:22 <DIR> Testing\r\n30.11.2016 15:06 <DIR> THIRD-PARTY-LICENSES\r\n29.11.2017 17:46 <DIR> Tools\r\n26.09.2017 12:31
<DIR> UC4_Systeme\r\n23.06.2017 10:39 <DIR> Users\r\n16.02.2017 15:07 <DIR> webdrivers\r\n12.03.2018 10:09 <DIR> Windows\r\n30.11.2016 12:21
40 windows-version.txt\r\n02.11.2016 13:00 <DIR> XXX_wir_sind_bei_sbb_XXX\r\n 2 File(s) 8.236 bytes\r\n 27 Dir(s) 215.454.625.792 bytes
free\r\n\r\nc:\\>C:\\Automic\\V12\\Agents\\UC2TS_WIN_MEH\\Bin\\UCXJWX6M.EXE JNR=0026350688 MNR=8001 PNR=2388 IPA=10.243.20.74 TYP=E RET=00000000 TXT=\" Job ended\" \r\nProgram 'UC4 Job
Messenger' version '12.2.0+low.build.1014' started\r\nUCMDJP: *********************************************************************\r\nUCMDJP: ** JOB 0026350688 (ProcID:0000014160) ENDED AT
17.04.2018/15:11:54 **\r\nUCMDJP: ** UTC TIME 17.04.2018/13:11:54 **\r\nUCMDJP: ** ---------------------------------------------------------------
**\r\nUCMDJP: ** USED: 0.000 CPU **\r\nUCMDJP: *********************************************************************\r\nProgram 'UC4 Job
Messenger' version '12.2.0+low.build.1014' terminated normally\r\n\r\nc:\\>GOTO JOBENDE \r\n"
}
],
"hasmore": false
}
With Pagination
Request: GET http://{host}:{port}/ae/api/v1/{client}/executions/{run id}/reports/REP?max_results=3&start_at=4
Example: http://my-jcp-host:8088/ae/api/v1/8001/executions/26350688/reports/REP?max_results=3&start_at=4
HTTP 200 Response:
{
"total": 12,
"data": [
{
"page": 4,
"content": "..."
},
{
"page": 5,
"content": "..."
},
{
"page": 6,
"content": "..."
}
],
"hasmore": true
}
Restart Execution
Simple (No Parameters)
Request: POST http://{host}:{port}/ae/api/v1/{client}/executions/{run id}/status
Passing neither input nor any restart related parameters.
Example: http://my-jcp-host:8088/ae/api/v1/8001/executions/23021234/status
{
"action": "restart"
}
HTTP 200 Response:
{
"run_id": 26350635
}
All Possible Parameters
Restart with all possible parameters.
Request: POST http://{host}:{port}/ae/api/v1/{client}/executions/{run id}/status
Passing input parameters (PromptSet values) and restart related parameters.
Example:http://my-jcp-host:8088/ae/api/v1/8001/executions/23021234/status
{
"action": "restart",
"restart":
{
"queue": "FAST.QUEUE",
"restart_point": "RP2",
"keep_start_type": "true",
"wait_for_manual_release": "false",
"inputs":
{
"TEXT1#": "restart text",
"NUMBER1#": "123456789"
}
}
}
HTTP 200 Response:
{
"run_id": 26350635
}
Cancel Execution
Non-Recursive
Request: POST http://{host}:{port}/ae/api/v1/{client}/executions/{run id}/status
Example: http://my-jcp-host:8088/ae/api/v1/8001/executions/23021234/status
{
"action": "cancel"
}
HTTP 200 Response:
{}
Recursive
Request: POST http://{host}:{port}/ae/api/v1/{client}/executions/{run id}/status
Applies only to executable objects that can have children (JSCH, JOBP, and JOBG).
Example: http://my-jcp-host:8088/ae/api/v1/8001/executions/23021234/status
HTTP 200 Response:
{}
Execution List
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: