superset2/docs/developer_docs_versioned_docs/version-6.1.0/api/get-security-permissions.StatusCodes.json

{
  "responses": {
    "200": {
      "content": {
        "application/json": {
          "schema": {
            "properties": {
              "count": {
                "description": "The total record count on the backend",
                "type": "number"
              },
              "description_columns": {
                "properties": {
                  "column_name": {
                    "description": "The description for the column name. Will be translated by babel",
                    "example": "A Nice description for the column",
                    "type": "string"
                  }
                },
                "type": "object"
              },
              "ids": {
                "description": "A list of item ids, useful when you don't know the column id",
                "items": { "type": "string" },
                "type": "array"
              },
              "label_columns": {
                "properties": {
                  "column_name": {
                    "description": "The label for the column name. Will be translated by babel",
                    "example": "A Nice label for the column",
                    "type": "string"
                  }
                },
                "type": "object"
              },
              "list_columns": {
                "description": "A list of columns",
                "items": { "type": "string" },
                "type": "array"
              },
              "list_title": {
                "description": "A title to render. Will be translated by babel",
                "example": "List Items",
                "type": "string"
              },
              "order_columns": {
                "description": "A list of allowed columns to sort",
                "items": { "type": "string" },
                "type": "array"
              },
              "result": {
                "description": "The result from the get list query",
                "items": {
                  "properties": {
                    "id": { "type": "integer" },
                    "name": { "maxLength": 100, "type": "string" }
                  },
                  "required": ["name"],
                  "type": "object",
                  "title": "PermissionApi.get_list"
                },
                "type": "array"
              }
            },
            "type": "object"
          },
          "example": {
            "count": 1,
            "description_columns": {
              "column_name": "A Nice description for the column"
            },
            "ids": ["string"],
            "label_columns": { "column_name": "A Nice label for the column" },
            "list_columns": ["string"],
            "list_title": "List Items",
            "order_columns": ["string"],
            "result": [{}]
          }
        }
      },
      "description": "Items from Model"
    },
    "400": {
      "content": {
        "application/json": {
          "schema": {
            "properties": { "message": { "type": "string" } },
            "type": "object"
          },
          "example": { "message": "Bad request: Invalid parameters provided" }
        }
      },
      "description": "Bad request"
    },
    "401": {
      "content": {
        "application/json": {
          "schema": {
            "properties": { "message": { "type": "string" } },
            "type": "object"
          },
          "example": { "message": "Unauthorized: Authentication required" }
        }
      },
      "description": "Unauthorized"
    },
    "422": {
      "content": {
        "application/json": {
          "schema": {
            "properties": { "message": { "type": "string" } },
            "type": "object"
          },
          "example": { "message": "Unprocessable entity: Validation error" }
        }
      },
      "description": "Could not process entity"
    },
    "500": {
      "content": {
        "application/json": {
          "schema": {
            "properties": { "message": { "type": "string" } },
            "type": "object"
          },
          "example": {
            "message": "Internal server error: An unexpected error occurred"
          }
        }
      },
      "description": "Fatal error"
    }
  }
}