Get Workflow History

Overview

This API returns information about a specific Workflow History.  Workflow History information is available for 100 days after Workflow execution start time.

Request

HTTP Request

POST https://[applicationURL]]/remote

Request Body

{
    "jwt": string,
    "c":"a83270b7",
    "configuration": {
        "getHistory": {
            "workflowId": string,
            "historyId": string
        }
    }
}

Property name	Value	Description
jwt	string	[Required] JWT created using the Google service account that has been registered with Magnus
c	a83270b7	[Required] Command for getting a Workflow History
configuration	nested object	[Required] Configuration of the request
configuration.getHistory	nested object	[Required] Get a Workflow History
configuration.getHistory.workflowId	string	[Required] The workflow ID
configuration.getHistory.historyId	string	[Required]  The History ID This is the History ID returned from the response from Remote Execution Workflow.  The History ID can also be found from Magnus Workflows History Browser.

Response

If the Workflow History is found successfully, the following response body will be returned:

{
    "status": "ok",
    "result": {
       "history": {
          "historyId": string,
          "workflowId": string,
          "runReason": string,
          "workflowOwners: string,
          "startTime": long,
          "endTime": long,
          "status": {
             "state": string,
             "error": {
                "reason": string,
                "message": string
             }
          }
       }
    }
}