getSmartLinkById
Get Smart Link in the content tree by id
Details
- Method:
GET - Path:
/embeds/{id} - Operation ID:
getSmartLinkById
Parameters
{
"id": {
"description": "The ID of the Smart Link in the content tree to be returned.",
"required": true,
"location": "path",
"type": "integer",
"format": "int64"
},
"include-collaborators": {
"description": "Includes collaborators on the Smart Link.",
"required": false,
"location": "query",
"type": "boolean"
},
"include-direct-children": {
"description": "Includes direct children of the Smart Link, as defined in the `ChildrenResponse` object.",
"required": false,
"location": "query",
"type": "boolean"
},
"include-operations": {
"description": "Includes operations associated with this Smart Link in the response, as defined in the `Operation` object.\nThe number of results will be limited to 50 and sorted in the default sort order.\nA `meta` and `_links` property will be present to indicate if more results are available and a link to retrieve the rest of the results.",
"required": false,
"location": "query",
"type": "boolean"
},
"include-properties": {
"description": "Includes content properties associated with this Smart Link in the response.\nThe number of results will be limited to 50 and sorted in the default sort order.\nA `meta` and `_links` property will be present to indicate if more results are available and a link to retrieve the rest of the results.",
"required": false,
"location": "query",
"type": "boolean"
}
}Response Schema
{
"allOf": [
{
"$ref": "#/components/schemas/SmartLinkSingle"
},
{
"type": "object",
"properties": {
"_links": {
"type": "object",
"properties": {
"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('getSmartLinkById', {
# Add required parameters here
})