Skip to content

Breakthrough Datasets

albert.resources.btdataset

BTDatasetReferences

Bases: BaseAlbertModel

Show JSON schema:
{
  "properties": {
    "project_ids": {
      "items": {
        "type": "string"
      },
      "title": "Project Ids",
      "type": "array"
    },
    "data_column_ids": {
      "items": {
        "type": "string"
      },
      "title": "Data Column Ids",
      "type": "array"
    },
    "sheet_ids": {
      "anyOf": [
        {
          "items": {
            "type": "string"
          },
          "type": "array"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Sheet Ids"
    },
    "filter": {
      "anyOf": [
        {
          "additionalProperties": true,
          "type": "object"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Filter"
    }
  },
  "required": [
    "project_ids",
    "data_column_ids"
  ],
  "title": "BTDatasetReferences",
  "type": "object"
}

Fields:

project_ids

project_ids: list[str]

data_column_ids

data_column_ids: list[str]

sheet_ids

sheet_ids: list[str] | None = None

filter

filter: dict[str, Any] | None = None

BTDataset

Bases: BaseResource

Show JSON schema:
{
  "$defs": {
    "AuditFields": {
      "description": "The audit fields for a resource",
      "properties": {
        "by": {
          "default": null,
          "title": "By",
          "type": "string"
        },
        "byName": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Byname"
        },
        "at": {
          "anyOf": [
            {
              "format": "date-time",
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "At"
        }
      },
      "title": "AuditFields",
      "type": "object"
    },
    "BTDatasetReferences": {
      "properties": {
        "project_ids": {
          "items": {
            "type": "string"
          },
          "title": "Project Ids",
          "type": "array"
        },
        "data_column_ids": {
          "items": {
            "type": "string"
          },
          "title": "Data Column Ids",
          "type": "array"
        },
        "sheet_ids": {
          "anyOf": [
            {
              "items": {
                "type": "string"
              },
              "type": "array"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Sheet Ids"
        },
        "filter": {
          "anyOf": [
            {
              "additionalProperties": true,
              "type": "object"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Filter"
        }
      },
      "required": [
        "project_ids",
        "data_column_ids"
      ],
      "title": "BTDatasetReferences",
      "type": "object"
    },
    "EntityLink": {
      "properties": {
        "id": {
          "title": "Id",
          "type": "string"
        },
        "name": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Name"
        }
      },
      "required": [
        "id"
      ],
      "title": "EntityLink",
      "type": "object"
    },
    "Status": {
      "description": "The status of a resource",
      "enum": [
        "active",
        "inactive"
      ],
      "title": "Status",
      "type": "string"
    }
  },
  "properties": {
    "status": {
      "anyOf": [
        {
          "$ref": "#/$defs/Status"
        },
        {
          "type": "null"
        }
      ],
      "default": null
    },
    "Created": {
      "anyOf": [
        {
          "$ref": "#/$defs/AuditFields"
        },
        {
          "type": "null"
        }
      ],
      "default": null
    },
    "Updated": {
      "anyOf": [
        {
          "$ref": "#/$defs/AuditFields"
        },
        {
          "type": "null"
        }
      ],
      "default": null
    },
    "name": {
      "title": "Name",
      "type": "string"
    },
    "albertId": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Albertid"
    },
    "key": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Key"
    },
    "fileName": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Filename"
    },
    "Report": {
      "anyOf": [
        {
          "$ref": "#/$defs/EntityLink"
        },
        {
          "type": "null"
        }
      ],
      "default": null
    },
    "References": {
      "anyOf": [
        {
          "$ref": "#/$defs/BTDatasetReferences"
        },
        {
          "type": "null"
        }
      ],
      "default": null
    }
  },
  "required": [
    "name"
  ],
  "title": "BTDataset",
  "type": "object"
}

Fields:

name

name: str

id

id: BTDatasetId | None = None

key

key: str | None = None

file_name

file_name: str | None = None

report

report: EntityLink | None = None

references

references: BTDatasetReferences | None = None