565bbe0aa5
Starter MCP Server generated from the official Box.com OpenAPI specifications for versions [2025.0](https://github.com/box/box-openapi/blob/main/openapi/openapi-v2025.0.json) and [2024.0](https://github.com/box/box-openapi/blob/main/openapi/openapi.json)
239 lines
8.8 KiB
JSON
239 lines
8.8 KiB
JSON
{
|
|
"name": "GetRetentionPolicyAssignments",
|
|
"fully_qualified_name": "BoxApi.GetRetentionPolicyAssignments@0.1.0",
|
|
"description": "Retrieve retention policy assignments by policy ID.\n\nThis tool returns a list of all retention policy assignments associated with a specified retention policy ID.",
|
|
"toolkit": {
|
|
"name": "ArcadeBoxApi",
|
|
"description": null,
|
|
"version": "0.1.0"
|
|
},
|
|
"input": {
|
|
"parameters": [
|
|
{
|
|
"name": "retention_policy_id",
|
|
"required": true,
|
|
"description": "The unique identifier of the retention policy to retrieve assignments for.",
|
|
"value_schema": {
|
|
"val_type": "string",
|
|
"inner_val_type": null,
|
|
"enum": null,
|
|
"properties": null,
|
|
"inner_properties": null,
|
|
"description": "The ID of the retention policy."
|
|
},
|
|
"inferrable": true,
|
|
"http_endpoint_parameter_name": "retention_policy_id"
|
|
},
|
|
{
|
|
"name": "assignment_type",
|
|
"required": false,
|
|
"description": "The type of retention policy assignment to retrieve, such as 'folder', 'enterprise', or 'metadata_template'.",
|
|
"value_schema": {
|
|
"val_type": "string",
|
|
"inner_val_type": null,
|
|
"enum": [
|
|
"folder",
|
|
"enterprise",
|
|
"metadata_template"
|
|
],
|
|
"properties": null,
|
|
"inner_properties": null,
|
|
"description": "The type of the retention policy assignment to retrieve."
|
|
},
|
|
"inferrable": true,
|
|
"http_endpoint_parameter_name": "type"
|
|
},
|
|
{
|
|
"name": "include_fields_in_response",
|
|
"required": false,
|
|
"description": "A list of attribute names to include in the response. These specify additional fields to return beyond the standard response.",
|
|
"value_schema": {
|
|
"val_type": "array",
|
|
"inner_val_type": "string",
|
|
"enum": null,
|
|
"properties": null,
|
|
"inner_properties": null,
|
|
"description": "A comma-separated list of attributes to include in the\nresponse. This can be used to request fields that are\nnot normally returned in a standard response.\n\nBe aware that specifying this parameter will have the\neffect that none of the standard fields are returned in\nthe response unless explicitly specified, instead only\nfields for the mini representation are returned, additional\nto the fields requested."
|
|
},
|
|
"inferrable": true,
|
|
"http_endpoint_parameter_name": "fields"
|
|
},
|
|
{
|
|
"name": "pagination_start_marker",
|
|
"required": false,
|
|
"description": "The position marker to begin returning results 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."
|
|
},
|
|
"inferrable": true,
|
|
"http_endpoint_parameter_name": "marker"
|
|
},
|
|
{
|
|
"name": "max_items_per_page",
|
|
"required": false,
|
|
"description": "The maximum number of items to return per page when retrieving retention policy assignments.",
|
|
"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_policies_id_assignments'.",
|
|
"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_policies/{retention_policy_id}/assignments",
|
|
"http_method": "GET",
|
|
"headers": {
|
|
"box-version": "2024.0"
|
|
},
|
|
"parameters": [
|
|
{
|
|
"name": "type",
|
|
"tool_parameter_name": "assignment_type",
|
|
"description": "The type of the retention policy assignment to retrieve.",
|
|
"value_schema": {
|
|
"val_type": "string",
|
|
"inner_val_type": null,
|
|
"enum": [
|
|
"folder",
|
|
"enterprise",
|
|
"metadata_template"
|
|
],
|
|
"properties": null,
|
|
"inner_properties": null,
|
|
"description": "The type of the retention policy assignment to retrieve."
|
|
},
|
|
"accepted_as": "query",
|
|
"required": false,
|
|
"deprecated": false,
|
|
"documentation_urls": []
|
|
},
|
|
{
|
|
"name": "fields",
|
|
"tool_parameter_name": "include_fields_in_response",
|
|
"description": "A comma-separated list of attributes to include in the\nresponse. This can be used to request fields that are\nnot normally returned in a standard response.\n\nBe aware that specifying this parameter will have the\neffect that none of the standard fields are returned in\nthe response unless explicitly specified, instead only\nfields for the mini representation are returned, additional\nto the fields requested.",
|
|
"value_schema": {
|
|
"val_type": "array",
|
|
"inner_val_type": "string",
|
|
"enum": null,
|
|
"properties": null,
|
|
"inner_properties": null,
|
|
"description": "A comma-separated list of attributes to include in the\nresponse. This can be used to request fields that are\nnot normally returned in a standard response.\n\nBe aware that specifying this parameter will have the\neffect that none of the standard fields are returned in\nthe response unless explicitly specified, instead only\nfields for the mini representation are returned, additional\nto the fields requested."
|
|
},
|
|
"accepted_as": "query",
|
|
"required": false,
|
|
"deprecated": false,
|
|
"documentation_urls": []
|
|
},
|
|
{
|
|
"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.",
|
|
"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."
|
|
},
|
|
"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_id",
|
|
"tool_parameter_name": "retention_policy_id",
|
|
"description": "The ID of the retention policy.",
|
|
"value_schema": {
|
|
"val_type": "string",
|
|
"inner_val_type": null,
|
|
"enum": null,
|
|
"properties": null,
|
|
"inner_properties": null,
|
|
"description": "The ID of the retention policy."
|
|
},
|
|
"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
|
|
}
|
|
]
|
|
}
|
|
}
|