getSpaceById
Get space by id
Details
- Method:
GET - Path:
/spaces/{id} - Operation ID:
getSpaceById
Parameters
{
"id": {
"description": "The ID of the space to be returned.",
"required": true,
"location": "path",
"type": "integer",
"format": "int64"
},
"description-format": {
"description": "The content format type to be returned in the `description` field of the response. If available, the representation will be available under a response field of the same name under the `description` field.",
"required": false,
"location": "query",
"type": "string",
"enum": [
"plain",
"view"
]
},
"include-icon": {
"description": "If the icon for the space should be fetched or not.",
"required": false,
"location": "query",
"type": "boolean"
},
"include-operations": {
"description": "Includes operations associated with this space 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 space properties associated with this space 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"
},
"include-permissions": {
"description": "Includes space permissions associated with this space 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"
},
"include-role-assignments": {
"description": "Includes role assignments associated with this space in the response. This parameter is only accepted for EAP sites.\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-labels": {
"description": "Includes labels associated with this space 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/SpaceSingle"
},
{
"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('getSpaceById', {
# Add required parameters here
})