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

bulkEditDashboards

Bulk edit dashboards

Details

  • Method: PUT
  • Path: /rest/api/3/dashboard/bulk/edit
  • Operation ID: bulkEditDashboards

Parameters

{
  "action": {
    "description": "Allowed action for bulk edit shareable entity",
    "required": true,
    "location": "body",
    "type": "string",
    "enum": [
      "changeOwner",
      "changePermission",
      "addPermission",
      "removePermission"
    ]
  },
  "changeOwnerDetails": {
    "description": "The details of change owner action.",
    "required": false,
    "location": "body",
    "type": "string"
  },
  "entityIds": {
    "description": "The id list of shareable entities to be changed.",
    "required": true,
    "location": "body",
    "type": "array"
  },
  "extendAdminPermissions": {
    "description": "Whether the actions are executed by users with Administer Jira global permission.",
    "required": false,
    "location": "body",
    "type": "boolean"
  },
  "permissionDetails": {
    "description": "The permission details to be changed.",
    "required": false,
    "location": "body",
    "type": "string"
  }
}

Response Schema

{
  "additionalProperties": false,
  "description": "Details of a request to bulk edit shareable entity.",
  "properties": {
    "action": {
      "description": "Allowed action for bulk edit shareable entity",
      "enum": [
        "changeOwner",
        "changePermission",
        "addPermission",
        "removePermission"
      ],
      "type": "string"
    },
    "entityErrors": {
      "additionalProperties": {
        "additionalProperties": false,
        "description": "Errors of bulk edit action.",
        "properties": {
          "errorMessages": {
            "description": "The error messages.",
            "items": {
              "type": "string"
            },
            "type": "array"
          },
          "errors": {
            "additionalProperties": {
              "type": "string"
            },
            "description": "The errors.",
            "type": "object"
          }
        },
        "required": [
          "errorMessages",
          "errors"
        ],
        "type": "object"
      },
      "description": "The mapping dashboard id to errors if any.",
      "type": "object"
    }
  },
  "required": [
    "action"
  ],
  "type": "object"
}

Usage

from ocp_agent import OCPAgent

agent = OCPAgent()
await agent.register_api('jira')

# Call this tool
result = await agent.call_tool('bulkEditDashboards', {
    # Add required parameters here
})