getSpaceProperties
Get space properties in space
Details
- Method:
GET - Path:
/spaces/{space-id}/properties - Operation ID:
getSpaceProperties
Parameters
{
"space-id": {
"description": "The ID of the space for which space properties should be returned.",
"required": true,
"location": "path",
"type": "integer",
"format": "int64"
},
"key": {
"description": "The key of the space property to retrieve. This should be used when a user knows the key of their property, but needs to retrieve the id for use in other methods.",
"required": false,
"location": "query",
"type": "string"
},
"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"
},
"limit": {
"description": "Maximum number of pages 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<SpaceProperty>",
"type": "object",
"properties": {
"results": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "ID of the space property."
},
"key": {
"type": "string",
"description": "Key of the space property."
},
"value": {
"description": "Value of the space property."
},
"createdAt": {
"type": "string",
"format": "date-time",
"description": "RFC3339 compliant date time at which the property was created."
},
"createdBy": {
"type": "string",
"description": "Atlassian account ID of the user that created the space property."
},
"version": {
"type": "object",
"properties": {
"createdAt": {
"type": "string",
"format": "date-time",
"description": "RFC3339 compliant date time at which the property's current version was created."
},
"createdBy": {
"type": "string",
"description": "Atlassian account ID of the user that created the space property's current version."
},
"message": {
"type": "string",
"description": "Message associated with the current version."
},
"number": {
"type": "integer",
"format": "int32",
"description": "The space property's current version number."
}
}
}
}
}
},
"_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('getSpaceProperties', {
# Add required parameters here
})