getChangeLogs
Get changelogs
Details
- Method:
GET - Path:
/rest/api/3/issue/{issueIdOrKey}/changelog - Operation ID:
getChangeLogs
Parameters
{
"issueIdOrKey": {
"description": "The ID or key of the issue.",
"required": true,
"location": "path",
"type": "string"
},
"startAt": {
"description": "The index of the first item to return in a page of results (page offset).",
"required": false,
"location": "query",
"type": "integer",
"format": "int32"
},
"maxResults": {
"description": "The maximum number of items to return per page.",
"required": false,
"location": "query",
"type": "integer",
"format": "int32"
}
}Response Schema
{
"additionalProperties": false,
"description": "A page of items.",
"properties": {
"isLast": {
"description": "Whether this is the last page.",
"readOnly": true,
"type": "boolean"
},
"maxResults": {
"description": "The maximum number of items that could be returned.",
"format": "int32",
"readOnly": true,
"type": "integer"
},
"nextPage": {
"description": "If there is another page of results, the URL of the next page.",
"format": "uri",
"readOnly": true,
"type": "string"
},
"self": {
"description": "The URL of the page.",
"format": "uri",
"readOnly": true,
"type": "string"
},
"startAt": {
"description": "The index of the first item returned.",
"format": "int64",
"readOnly": true,
"type": "integer"
},
"total": {
"description": "The number of items returned.",
"format": "int64",
"readOnly": true,
"type": "integer"
},
"values": {
"description": "The list of items.",
"items": {
"additionalProperties": false,
"description": "A log of changes made to issue fields. Changelogs related to workflow associations are currently being deprecated.",
"properties": {
"author": {
"allOf": [
{
"$ref": "#/components/schemas/UserDetails"
}
],
"description": "The user who made the change.",
"readOnly": true
},
"created": {
"description": "The date on which the change took place.",
"format": "date-time",
"readOnly": true,
"type": "string"
},
"historyMetadata": {
"allOf": [
{
"$ref": "#/components/schemas/HistoryMetadata"
}
],
"description": "The history metadata associated with the changed.",
"readOnly": true
},
"id": {
"description": "The ID of the changelog.",
"readOnly": true,
"type": "string"
},
"items": {
"description": "The list of items changed.",
"items": {
"additionalProperties": false,
"description": "A change item.",
"properties": {
"field": {
"description": "The name of the field changed.",
"readOnly": true,
"type": "string"
},
"fieldId": {
"description": "The ID of the field changed.",
"readOnly": true,
"type": "string"
},
"fieldtype": {
"description": "The type of the field changed.",
"readOnly": true,
"type": "string"
},
"from": {
"description": "The details of the original value.",
"readOnly": true,
"type": "string"
},
"fromString": {
"description": "The details of the original value as a string.",
"readOnly": true,
"type": "string"
},
"to": {
"description": "The details of the new value.",
"readOnly": true,
"type": "string"
},
"toString": {
"description": "The details of the new value as a string.",
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"readOnly": true,
"type": "array"
}
},
"type": "object"
},
"readOnly": true,
"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('getChangeLogs', {
# Add required parameters here
})