updateAttachmentPropertyById
Update content property for attachment by id
Details
- Method:
PUT - Path:
/attachments/{attachment-id}/properties/{property-id} - Operation ID:
updateAttachmentPropertyById
Parameters
{
"attachment-id": {
"description": "The ID of the attachment the property belongs to.",
"required": true,
"location": "path",
"type": "string"
},
"property-id": {
"description": "The ID of the property to be updated.",
"required": true,
"location": "path",
"type": "integer",
"format": "int64"
},
"key": {
"description": "Key of the content property",
"required": false,
"location": "body",
"type": "string"
},
"value": {
"description": "Value of the content property.",
"required": false,
"location": "body",
"type": "string"
},
"version": {
"description": "New version number and associated message",
"required": false,
"location": "body",
"type": "object"
}
}Response Schema
{
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "ID of the property"
},
"key": {
"type": "string",
"description": "Key of the property"
},
"value": {
"description": "Value of the property. Must be a valid JSON value."
},
"version": {
"type": "object",
"properties": {
"createdAt": {
"type": "string",
"format": "date-time",
"description": "Date and time when the version was created. In format \"YYYY-MM-DDTHH:mm:ss.sssZ\"."
},
"message": {
"type": "string",
"description": "Message associated with the current version."
},
"number": {
"format": "int32",
"type": "integer",
"description": "The version number."
},
"minorEdit": {
"type": "boolean",
"description": "Describes if this version is a minor version. Email notifications and activity stream updates are not created for minor versions."
},
"authorId": {
"type": "string",
"description": "The account ID of the user who created this version."
}
}
}
}
}Usage
from ocp_agent import OCPAgent
agent = OCPAgent()
await agent.register_api('confluence')
# Call this tool
result = await agent.call_tool('updateAttachmentPropertyById', {
# Add required parameters here
})