Open Context Protocol is live! 🚀 Read the launch post

getTasks

Get tasks

Details

  • Method: GET
  • Path: /tasks
  • Operation ID: getTasks

Parameters

{
  "body-format": {
    "description": "The content format types to be returned in the `body` field of the response. If available, the representation will be available under a response field of the same name under the `body` field.",
    "required": false,
    "location": "query",
    "type": "string",
    "enum": [
      "storage",
      "atlas_doc_format"
    ]
  },
  "include-blank-tasks": {
    "description": "Specifies whether to include blank tasks in the response. Defaults to `true`.",
    "required": false,
    "location": "query",
    "type": "boolean"
  },
  "status": {
    "description": "Filters on the status of the task.",
    "required": false,
    "location": "query",
    "type": "string",
    "enum": [
      "complete",
      "incomplete"
    ]
  },
  "task-id": {
    "description": "Filters on task ID. Multiple IDs can be specified.",
    "required": false,
    "location": "query",
    "type": "array"
  },
  "space-id": {
    "description": "Filters on the space ID of the task. Multiple IDs can be specified.",
    "required": false,
    "location": "query",
    "type": "array"
  },
  "page-id": {
    "description": "Filters on the page ID of the task. Multiple IDs can be specified. Note - page and blog post filters can be used in conjunction.",
    "required": false,
    "location": "query",
    "type": "array"
  },
  "blogpost-id": {
    "description": "Filters on the blog post ID of the task. Multiple IDs can be specified. Note - page and blog post filters can be used in conjunction.",
    "required": false,
    "location": "query",
    "type": "array"
  },
  "created-by": {
    "description": "Filters on the Account ID of the user who created this task. Multiple IDs can be specified.",
    "required": false,
    "location": "query",
    "type": "array"
  },
  "assigned-to": {
    "description": "Filters on the Account ID of the user to whom this task is assigned. Multiple IDs can be specified.",
    "required": false,
    "location": "query",
    "type": "array"
  },
  "completed-by": {
    "description": "Filters on the Account ID of the user who completed this task. Multiple IDs can be specified.",
    "required": false,
    "location": "query",
    "type": "array"
  },
  "created-at-from": {
    "description": "Filters on start of date-time range of task based on creation date (inclusive). Input is epoch time in milliseconds.",
    "required": false,
    "location": "query",
    "type": "integer",
    "format": "int64"
  },
  "created-at-to": {
    "description": "Filters on end of date-time range of task based on creation date (inclusive). Input is epoch time in milliseconds.",
    "required": false,
    "location": "query",
    "type": "integer",
    "format": "int64"
  },
  "due-at-from": {
    "description": "Filters on start of date-time range of task based on due date (inclusive). Input is epoch time in milliseconds.",
    "required": false,
    "location": "query",
    "type": "integer",
    "format": "int64"
  },
  "due-at-to": {
    "description": "Filters on end of date-time range of task based on due date (inclusive). Input is epoch time in milliseconds.",
    "required": false,
    "location": "query",
    "type": "integer",
    "format": "int64"
  },
  "completed-at-from": {
    "description": "Filters on start of date-time range of task based on completion date (inclusive). Input is epoch time in milliseconds.",
    "required": false,
    "location": "query",
    "type": "integer",
    "format": "int64"
  },
  "completed-at-to": {
    "description": "Filters on end of date-time range of task based on completion date (inclusive). Input is epoch time in milliseconds.",
    "required": false,
    "location": "query",
    "type": "integer",
    "format": "int64"
  },
  "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 tasks 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<Task>",
  "type": "object",
  "properties": {
    "results": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "description": "ID of the task."
          },
          "localId": {
            "type": "string",
            "description": "Local ID of the task. This ID is local to the corresponding page or blog post."
          },
          "spaceId": {
            "type": "string",
            "description": "ID of the space the task is in."
          },
          "pageId": {
            "type": "string",
            "description": "ID of the page the task is in."
          },
          "blogPostId": {
            "type": "string",
            "description": "ID of the blog post the task is in."
          },
          "status": {
            "enum": [
              "complete",
              "incomplete"
            ],
            "type": "string",
            "description": "Status of the task."
          },
          "body": {
            "type": "object",
            "description": "Contains fields for each representation type requested.",
            "properties": {
              "storage": {
                "type": "object",
                "properties": {
                  "representation": {
                    "type": "string",
                    "description": "Type of content representation used for the value field."
                  },
                  "value": {
                    "type": "string",
                    "description": "Body of the content, in the format found in the representation field."
                  }
                }
              },
              "atlas_doc_format": {
                "type": "object",
                "properties": {
                  "representation": {
                    "type": "string",
                    "description": "Type of content representation used for the value field."
                  },
                  "value": {
                    "type": "string",
                    "description": "Body of the content, in the format found in the representation field."
                  }
                }
              }
            }
          },
          "createdBy": {
            "type": "string",
            "description": "Account ID of the user who created this task."
          },
          "assignedTo": {
            "type": "string",
            "description": "Account ID of the user to whom this task is assigned."
          },
          "completedBy": {
            "type": "string",
            "description": "Account ID of the user who completed this task."
          },
          "createdAt": {
            "type": "string",
            "format": "date-time",
            "description": "Date and time when the task was created. In format \"YYYY-MM-DDTHH:mm:ss.sssZ\"."
          },
          "updatedAt": {
            "type": "string",
            "format": "date-time",
            "description": "Date and time when the task was updated. In format \"YYYY-MM-DDTHH:mm:ss.sssZ\"."
          },
          "dueAt": {
            "type": "string",
            "format": "date-time",
            "description": "Date and time when the task is due. In format \"YYYY-MM-DDTHH:mm:ss.sssZ\"."
          },
          "completedAt": {
            "type": "string",
            "format": "date-time",
            "description": "Date and time when the task was completed. In format \"YYYY-MM-DDTHH:mm:ss.sssZ\"."
          }
        }
      }
    },
    "_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('getTasks', {
    # Add required parameters here
})