arcade-mcp/toolkits/box_api/arcade_box_api/wrapper_tools/GetFileVersionsUnderRetention.json

{
  "name": "GetFileVersionsUnderRetention",
  "fully_qualified_name": "BoxApi.GetFileVersionsUnderRetention@0.1.0",
  "description": "Fetch file versions under a specific retention policy assignment.\n\nThis tool retrieves a list of file versions that are currently under retention for a specified retention policy assignment. Use it to manage or review file retention statuses.",
  "toolkit": {
    "name": "ArcadeBoxApi",
    "description": null,
    "version": "0.1.0"
  },
  "input": {
    "parameters": [
      {
        "name": "retention_policy_assignment_id",
        "required": true,
        "description": "The ID of the retention policy assignment to retrieve file versions under retention.",
        "value_schema": {
          "val_type": "string",
          "inner_val_type": null,
          "enum": null,
          "properties": null,
          "inner_properties": null,
          "description": "The ID of the retention policy assignment."
        },
        "inferrable": true,
        "http_endpoint_parameter_name": "retention_policy_assignment_id"
      },
      {
        "name": "pagination_start_marker",
        "required": false,
        "description": "Defines the position marker to start returning results. Requires `usemarker` to be `true` for marker-based pagination.",
        "value_schema": {
          "val_type": "string",
          "inner_val_type": null,
          "enum": null,
          "properties": null,
          "inner_properties": null,
          "description": "Defines the position marker at which to begin returning results. This is\nused when paginating using marker-based pagination.\n\nThis requires `usemarker` to be set to `true`."
        },
        "inferrable": true,
        "http_endpoint_parameter_name": "marker"
      },
      {
        "name": "max_items_per_page",
        "required": false,
        "description": "Specifies the maximum number of file versions to return per page during retrieval.",
        "value_schema": {
          "val_type": "integer",
          "inner_val_type": null,
          "enum": null,
          "properties": null,
          "inner_properties": null,
          "description": "The maximum number of items to return per page."
        },
        "inferrable": true,
        "http_endpoint_parameter_name": "limit"
      }
    ]
  },
  "output": {
    "description": "Response from the API endpoint 'get_retention_policy_assignments_id_file_versions_under_retention'.",
    "available_modes": [
      "value",
      "error",
      "null"
    ],
    "value_schema": {
      "val_type": "json",
      "inner_val_type": null,
      "enum": null,
      "properties": null,
      "inner_properties": null,
      "description": null
    }
  },
  "requirements": {
    "authorization": {
      "provider_id": "arcade-box",
      "provider_type": "oauth2",
      "id": null,
      "oauth2": null
    },
    "secrets": null,
    "metadata": null
  },
  "deprecation_message": null,
  "metadata": {
    "object_type": "api_wrapper_tool",
    "version": "1.0.0",
    "description": "Tools that enable LLMs to interact directly with the box API."
  },
  "http_endpoint": {
    "metadata": {
      "object_type": "http_endpoint",
      "version": "1.0.0",
      "description": ""
    },
    "url": "https://api.box.com/2.0/retention_policy_assignments/{retention_policy_assignment_id}/file_versions_under_retention",
    "http_method": "GET",
    "headers": {
      "box-version": "2024.0"
    },
    "parameters": [
      {
        "name": "marker",
        "tool_parameter_name": "pagination_start_marker",
        "description": "Defines the position marker at which to begin returning results. This is\nused when paginating using marker-based pagination.\n\nThis requires `usemarker` to be set to `true`.",
        "value_schema": {
          "val_type": "string",
          "inner_val_type": null,
          "enum": null,
          "properties": null,
          "inner_properties": null,
          "description": "Defines the position marker at which to begin returning results. This is\nused when paginating using marker-based pagination.\n\nThis requires `usemarker` to be set to `true`."
        },
        "accepted_as": "query",
        "required": false,
        "deprecated": false,
        "documentation_urls": []
      },
      {
        "name": "limit",
        "tool_parameter_name": "max_items_per_page",
        "description": "The maximum number of items to return per page.",
        "value_schema": {
          "val_type": "integer",
          "inner_val_type": null,
          "enum": null,
          "properties": null,
          "inner_properties": null,
          "description": "The maximum number of items to return per page."
        },
        "accepted_as": "query",
        "required": false,
        "deprecated": false,
        "documentation_urls": []
      },
      {
        "name": "retention_policy_assignment_id",
        "tool_parameter_name": "retention_policy_assignment_id",
        "description": "The ID of the retention policy assignment.",
        "value_schema": {
          "val_type": "string",
          "inner_val_type": null,
          "enum": null,
          "properties": null,
          "inner_properties": null,
          "description": "The ID of the retention policy assignment."
        },
        "accepted_as": "path",
        "required": true,
        "deprecated": false,
        "documentation_urls": []
      }
    ],
    "documentation_urls": [],
    "secrets": [
      {
        "arcade_key": "auth_token",
        "parameter_name": "Authorization",
        "accepted_as": "header",
        "formatted_value": "Bearer {authorization}",
        "description": "The OAuth token to use for authentication.",
        "is_auth_token": true
      }
    ]
  }
}