superset2/docs/developer_docs_versioned_docs/version-6.1.0/api/get-security-groups-by-pk.StatusCodes.json

{
  "responses": {
    "200": {
      "content": {
        "application/json": {
          "schema": {
            "properties": {
              "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"
              },
              "id": { "description": "The item id", "type": "string" },
              "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"
              },
              "result": {
                "properties": {
                  "description": {
                    "maxLength": 512,
                    "nullable": true,
                    "type": "string"
                  },
                  "id": { "type": "integer" },
                  "label": {
                    "maxLength": 150,
                    "nullable": true,
                    "type": "string"
                  },
                  "name": { "maxLength": 100, "type": "string" },
                  "roles": {
                    "properties": {
                      "id": { "type": "integer" },
                      "name": { "maxLength": 64, "type": "string" }
                    },
                    "required": ["name"],
                    "type": "object",
                    "title": "GroupApi.get.Role"
                  },
                  "users": {
                    "properties": {
                      "id": { "type": "integer" },
                      "username": { "maxLength": 128, "type": "string" }
                    },
                    "required": ["username"],
                    "type": "object",
                    "title": "GroupApi.get.User"
                  }
                },
                "required": ["name"],
                "type": "object",
                "title": "GroupApi.get"
              },
              "show_columns": {
                "description": "A list of columns",
                "items": { "type": "string" },
                "type": "array"
              },
              "show_title": {
                "description": "A title to render. Will be translated by babel",
                "example": "Show Item Details",
                "type": "string"
              }
            },
            "type": "object"
          },
          "example": {
            "description_columns": {
              "column_name": "A Nice description for the column"
            },
            "id": "string",
            "label_columns": { "column_name": "A Nice label for the column" },
            "result": {
              "description": "string",
              "id": 1,
              "label": "string",
              "name": "string"
            },
            "show_columns": ["string"],
            "show_title": "Show Item Details"
          }
        }
      },
      "description": "Item 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"
    },
    "404": {
      "content": {
        "application/json": {
          "schema": {
            "properties": { "message": { "type": "string" } },
            "type": "object"
          },
          "example": {
            "message": "Not found: The requested resource does not exist"
          }
        }
      },
      "description": "Not found"
    },
    "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"
    }
  }
}