getAttachments
Get attachments
Details
- Method:
GET - Path:
/attachments - Operation ID:
getAttachments
Parameters
{
"sort": {
"description": "Used to sort the result by a particular field.",
"required": false,
"location": "query",
"type": "string",
"enum": [
"created-date",
"-created-date",
"modified-date",
"-modified-date"
]
},
"cursor": {
"description": "Used for pagination, this opaque cursor will be returned in the `next` URL in the `Link` response header. Use the relative URL in the `Link` header to retrieve the `next` set of results.",
"required": false,
"location": "query",
"type": "string"
},
"status": {
"description": "Filter the results to attachments based on their status. By default, `current` and `archived` are used.",
"required": false,
"location": "query",
"type": "array"
},
"mediaType": {
"description": "Filters on the mediaType of attachments. Only one may be specified.",
"required": false,
"location": "query",
"type": "string"
},
"filename": {
"description": "Filters on the file-name of attachments. Only one may be specified.",
"required": false,
"location": "query",
"type": "string"
},
"limit": {
"description": "Maximum number of attachments per result to return. If more results exist, use the `Link` header to retrieve a relative URL that will return the next set of results.",
"required": false,
"location": "query",
"type": "integer",
"format": "int32"
}
}Response Schema
{
"title": "MultiEntityResult<Attachment>",
"type": "object",
"properties": {
"results": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "ID of the attachment."
},
"status": {
"enum": [
"current",
"draft",
"archived",
"historical",
"trashed",
"deleted",
"any"
],
"type": "string",
"description": "The status of the content."
},
"title": {
"type": "string",
"description": "Title of the comment."
},
"createdAt": {
"type": "string",
"format": "date-time",
"description": "Date and time when the attachment was created. In format \"YYYY-MM-DDTHH:mm:ss.sssZ\"."
},
"pageId": {
"type": "string",
"description": "ID of the containing page.\n\nNote: This is only returned if the attachment has a container that is a page."
},
"blogPostId": {
"type": "string",
"description": "ID of the containing blog post.\n\nNote: This is only returned if the attachment has a container that is a blog post."
},
"customContentId": {
"type": "string",
"description": "ID of the containing custom content.\n\nNote: This is only returned if the attachment has a container that is custom content."
},
"mediaType": {
"type": "string",
"description": "Media Type for the attachment."
},
"mediaTypeDescription": {
"type": "string",
"description": "Media Type description for the attachment."
},
"comment": {
"type": "string",
"description": "Comment for the attachment."
},
"fileId": {
"type": "string",
"description": "File ID of the attachment. This is the ID referenced in `atlas_doc_format` bodies and is distinct from the attachment ID."
},
"fileSize": {
"format": "int64",
"type": "integer",
"description": "File size of the attachment."
},
"webuiLink": {
"type": "string",
"description": "WebUI link of the attachment."
},
"downloadLink": {
"type": "string",
"description": "Download link of the attachment."
},
"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."
}
}
},
"_links": {
"type": "object",
"properties": {
"webui": {
"type": "string",
"description": "Web UI link of the content."
},
"download": {
"type": "string",
"description": "Download link of the content."
}
}
}
}
}
},
"_links": {
"type": "object",
"properties": {
"next": {
"type": "string",
"description": "Used for pagination. Contains the relative URL for the next set of results, using a cursor query parameter.\nThis property will not be present if there is no additional data available."
},
"base": {
"type": "string",
"description": "Base url of the Confluence site."
}
}
}
}
}Usage
from ocp_agent import OCPAgent
agent = OCPAgent()
await agent.register_api('confluence')
# Call this tool
result = await agent.call_tool('getAttachments', {
# Add required parameters here
})