getAttachmentLabels
Get labels for attachment
Details
- Method:
GET - Path:
/attachments/{id}/labels - Operation ID:
getAttachmentLabels
Parameters
{
"id": {
"description": "The ID of the attachment for which labels should be returned.",
"required": true,
"location": "path",
"type": "integer",
"format": "int64"
},
"prefix": {
"description": "Filter the results to labels based on their prefix.",
"required": false,
"location": "query",
"type": "string",
"enum": [
"my",
"team",
"global",
"system"
]
},
"sort": {
"description": "Used to sort the result by a particular field.",
"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 labels 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<Label>",
"type": "object",
"properties": {
"results": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "ID of the label."
},
"name": {
"type": "string",
"description": "Name of the label."
},
"prefix": {
"type": "string",
"description": "Prefix of the label."
}
}
}
},
"_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('getAttachmentLabels', {
# Add required parameters here
})