Open Context Protocol is live! 🚀 Read the launch post
getWhiteboardContentProperties

getWhiteboardContentProperties

Get content properties for whiteboard

Details

  • Method: GET
  • Path: /whiteboards/{id}/properties
  • Operation ID: getWhiteboardContentProperties

Parameters

{
  "id": {
    "description": "The ID of the whiteboard for which content properties should be returned.",
    "required": true,
    "location": "path",
    "type": "integer",
    "format": "int64"
  },
  "key": {
    "description": "Filters the response to return a specific content property with matching key (case sensitive).",
    "required": false,
    "location": "query",
    "type": "string"
  },
  "sort": {
    "description": "Used to sort the result by a particular field.",
    "required": false,
    "location": "query",
    "type": "string",
    "enum": [
      "key",
      "-key"
    ]
  },
  "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 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<ContentProperty>",
  "type": "object",
  "properties": {
    "results": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "description": "ID of the property"
          },
          "key": {
            "type": "string",
            "description": "Key of the property"
          },
          "value": {
            "description": "Value of the property. Must be a valid JSON value."
          },
          "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": {
        "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('getWhiteboardContentProperties', {
    # Add required parameters here
})