Open Context Protocol is live! 🚀 Read the launch post
listWorkflowHistory

listWorkflowHistory

List workflow history entries

Details

  • Method: POST
  • Path: /rest/api/3/workflow/history/list
  • Operation ID: listWorkflowHistory

Parameters

{
  "expand": {
    "description": "Use [expand](#expansion) to include additional information in the response. This parameter accepts a comma-separated list. Expand options include:\n\n *  `includeIntermediateWorkflows` Includes intermediate workflow versions that are sometimes created during workflow updates or migrations. By default, these are omitted from the response.",
    "required": false,
    "location": "query",
    "type": "string"
  },
  "workflowId": {
    "description": "The id of the workflow to read the history for.",
    "required": false,
    "location": "body",
    "type": "string"
  }
}

Response Schema

{
  "additionalProperties": false,
  "description": "A list of workflow history entries.",
  "properties": {
    "entries": {
      "items": {
        "additionalProperties": false,
        "description": "A single entry in the WorkflowHistoryPage.",
        "properties": {
          "isIntermediate": {
            "description": "Whether the version is an intermediate workflow state, sometimes created during workflow updates.",
            "type": "boolean"
          },
          "workflowId": {
            "type": "string"
          },
          "workflowVersion": {
            "format": "int64",
            "type": "integer"
          },
          "writtenAt": {
            "description": "The timestamp when this workflow version was created.",
            "type": "string"
          }
        },
        "type": "object"
      },
      "type": "array"
    }
  },
  "type": "object"
}

Usage

from ocp_agent import OCPAgent

agent = OCPAgent()
await agent.register_api('jira')

# Call this tool
result = await agent.call_tool('listWorkflowHistory', {
    # Add required parameters here
})