AE REST API - Comments on Executions

You can get and add comments on executions.

This page includes the following:

Get Comment on 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 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"
}