User service objects

Objects and models for projects and user preferences. See supported User service APIs.

vianops_client.models.userservice.projects

pydantic model V1BaseProject

Bases: BaseModel

Show JSON schema
{
   "title": "V1BaseProject",
   "type": "object",
   "properties": {
      "name": {
         "title": "Name",
         "description": "name of the project",
         "type": "string"
      },
      "description": {
         "title": "Description",
         "description": "project description",
         "type": "string"
      },
      "status": {
         "title": "Status",
         "description": "project status",
         "type": "string"
      },
      "parent_project_uuid": {
         "title": "Parent Project Uuid",
         "description": "parent project id",
         "type": "string"
      },
      "created_ts": {
         "title": "Created Ts",
         "description": "Unix time in milliseconds generated at creation time.",
         "type": "string",
         "format": "date-time"
      },
      "modified_ts": {
         "title": "Modified Ts",
         "description": "Unix time in milliseconds generated at last modification time.",
         "type": "string",
         "format": "date-time"
      },
      "created_by": {
         "title": "Created By",
         "description": "user that created the project",
         "type": "string"
      },
      "modified_by": {
         "title": "Modified By",
         "description": "user that modified the project",
         "type": "string"
      }
   },
   "example": {
      "description": "project description",
      "status": "active",
      "parent_project_uuid": "0",
      "created_ts": 1675292368,
      "modified_ts": 1675292368,
      "created_by": "user1",
      "modified_by": "user1"
   }
}

Config:
  • orm_mode: bool = True

  • schema_extra: dict = {‘example’: {‘description’: ‘project description’, ‘status’: ‘active’, ‘parent_project_uuid’: ‘0’, ‘created_ts’: 1675292368, ‘modified_ts’: 1675292368, ‘created_by’: ‘user1’, ‘modified_by’: ‘user1’}}

Fields:
field created_by: str | None = None

user that created the project

field created_ts: datetime | None = None

Unix time in milliseconds generated at creation time.

field description: str | None = None

project description

field modified_by: str | None = None

user that modified the project

field modified_ts: datetime | None = None

Unix time in milliseconds generated at last modification time.

field name: str | None = None

name of the project

field parent_project_uuid: str | None = None

parent project id

field status: str | None = None

project status

pydantic model V1Project

Bases: V1BaseProject

Show JSON schema
{
   "title": "V1Project",
   "type": "object",
   "properties": {
      "name": {
         "title": "Name",
         "description": "name of the project",
         "type": "string"
      },
      "description": {
         "title": "Description",
         "description": "project description",
         "type": "string"
      },
      "status": {
         "title": "Status",
         "description": "project status",
         "type": "string"
      },
      "parent_project_uuid": {
         "title": "Parent Project Uuid",
         "description": "parent project id",
         "type": "string"
      },
      "created_ts": {
         "title": "Created Ts",
         "description": "Unix time in milliseconds generated at creation time.",
         "type": "string",
         "format": "date-time"
      },
      "modified_ts": {
         "title": "Modified Ts",
         "description": "Unix time in milliseconds generated at last modification time.",
         "type": "string",
         "format": "date-time"
      },
      "created_by": {
         "title": "Created By",
         "description": "user that created the project",
         "type": "string"
      },
      "modified_by": {
         "title": "Modified By",
         "description": "user that modified the project",
         "type": "string"
      },
      "uuid": {
         "title": "Uuid",
         "description": "uuid of the project",
         "type": "string"
      }
   },
   "required": [
      "name"
   ],
   "example": {
      "uuid": "0",
      "name": "Example Project",
      "description": "project description",
      "status": "active",
      "parent_project_uuid": "0",
      "created_ts": 1675292368,
      "modified_ts": 1675292368,
      "created_by": "user1",
      "modified_by": "user1"
   }
}

Config:
  • orm_mode: bool = True

  • schema_extra: dict = {‘example’: {‘uuid’: ‘0’, ‘name’: ‘Example Project’, ‘description’: ‘project description’, ‘status’: ‘active’, ‘parent_project_uuid’: ‘0’, ‘created_ts’: 1675292368, ‘modified_ts’: 1675292368, ‘created_by’: ‘user1’, ‘modified_by’: ‘user1’}}

Fields:
field name: str [Required]

name of the project

field uuid: str | None = None

uuid of the project

pydantic model V1ProjectFilters

Bases: V1Filters

Show JSON schema
{
   "title": "V1ProjectFilters",
   "type": "object",
   "properties": {
      "created_by": {
         "title": "Created By",
         "description": "List of 'created by' users to search for.",
         "type": "array",
         "items": {
            "type": "string"
         }
      },
      "modified_by": {
         "title": "Modified By",
         "description": "List of 'modified by' users to search for.",
         "type": "array",
         "items": {
            "type": "string"
         }
      },
      "created_ts_start": {
         "title": "Created Ts Start",
         "description": "Unix time in milliseconds for searching for all objects created during a specified time period.",
         "type": "number"
      },
      "created_ts_end": {
         "title": "Created Ts End",
         "description": "Unix time in milliseconds for searching for all objects created during a specified time period.",
         "type": "number"
      },
      "modified_ts_start": {
         "title": "Modified Ts Start",
         "description": "Unix time in milliseconds for searching for all objects modified during a specified time period.",
         "type": "number"
      },
      "modified_ts_end": {
         "title": "Modified Ts End",
         "description": "Unix time in milliseconds for searching for all objects modified during a specified time period.",
         "type": "number"
      },
      "uuids": {
         "title": "Uuids",
         "description": "List of uuids for this operation.",
         "type": "array",
         "items": {
            "type": "string"
         }
      },
      "names": {
         "title": "Names",
         "description": "List of names for this operation.",
         "type": "array",
         "items": {
            "type": "string"
         }
      },
      "statuses": {
         "title": "Statuses",
         "description": "List of statuses for this operation.",
         "type": "array",
         "items": {
            "type": "string"
         }
      },
      "descriptions": {
         "title": "Descriptions",
         "description": "List of project descriptions for this operation.",
         "type": "array",
         "items": {
            "type": "string"
         }
      }
   },
   "example": {
      "uuids": [
         "5efc9544-e84a-4a94-9e6d-5774e1c609ab",
         "9140dd05-3f7a-49a4-b625-379880bd9606"
      ],
      "names": [
         "Example project"
      ]
   }
}

Config:
  • fields: dict = {‘uuid’: ‘uuids’, ‘name’: ‘names’, ‘description’: ‘descriptions’, ‘status’: ‘statuses’}

  • schema_extra: dict = {‘example’: {‘uuids’: [‘5efc9544-e84a-4a94-9e6d-5774e1c609ab’, ‘9140dd05-3f7a-49a4-b625-379880bd9606’], ‘names’: [‘Example project’]}}

Fields:
field description: List[str] | None = None (alias 'descriptions')

List of project descriptions for this operation.

pydantic model V1ProjectList

Bases: BaseModel

Show JSON schema
{
   "title": "V1ProjectList",
   "type": "array",
   "items": {
      "$ref": "#/definitions/V1Project"
   },
   "definitions": {
      "V1Project": {
         "title": "V1Project",
         "type": "object",
         "properties": {
            "name": {
               "title": "Name",
               "description": "name of the project",
               "type": "string"
            },
            "description": {
               "title": "Description",
               "description": "project description",
               "type": "string"
            },
            "status": {
               "title": "Status",
               "description": "project status",
               "type": "string"
            },
            "parent_project_uuid": {
               "title": "Parent Project Uuid",
               "description": "parent project id",
               "type": "string"
            },
            "created_ts": {
               "title": "Created Ts",
               "description": "Unix time in milliseconds generated at creation time.",
               "type": "string",
               "format": "date-time"
            },
            "modified_ts": {
               "title": "Modified Ts",
               "description": "Unix time in milliseconds generated at last modification time.",
               "type": "string",
               "format": "date-time"
            },
            "created_by": {
               "title": "Created By",
               "description": "user that created the project",
               "type": "string"
            },
            "modified_by": {
               "title": "Modified By",
               "description": "user that modified the project",
               "type": "string"
            },
            "uuid": {
               "title": "Uuid",
               "description": "uuid of the project",
               "type": "string"
            }
         },
         "required": [
            "name"
         ],
         "example": {
            "uuid": "0",
            "name": "Example Project",
            "description": "project description",
            "status": "active",
            "parent_project_uuid": "0",
            "created_ts": 1675292368,
            "modified_ts": 1675292368,
            "created_by": "user1",
            "modified_by": "user1"
         }
      }
   }
}

Fields:
  • __root__ (List[vianops_client.models.userservice.projects.V1Project])

pydantic model V1ProjectSearch

Bases: V1PageSearch

Show JSON schema
{
   "title": "V1ProjectSearch",
   "type": "object",
   "properties": {
      "page": {
         "title": "Page",
         "description": "Page number to return. Zero-index based. Cannot be less than zero or greater than number of pages. To make sure you don't exceed the number of pages, set `page` to 1 and run this search operation to return the total number items (`total`). Then run it again to return the exact page (`page`) for the specified number of items per page (`page-size`).",
         "type": "integer"
      },
      "page_size": {
         "title": "Page Size",
         "description": "Number of items to return on a page. Default is 25 items per page.",
         "default": 25,
         "type": "integer"
      },
      "order": {
         "title": "Order",
         "description": "Fields to use for ordering returned pages and the sort direction.",
         "type": "array",
         "items": {
            "$ref": "#/definitions/V1OrderBy"
         }
      },
      "search": {
         "title": "Search",
         "description": "String to search for (case-insensitive) across all fields in previously created items.",
         "type": "string"
      },
      "filters": {
         "title": "Filters",
         "description": "Specifies different condition(s) for filtering the results. If not provided, all relevant results are retrieved.",
         "default": {
            "created_by": null,
            "modified_by": null,
            "created_ts_start": null,
            "created_ts_end": null,
            "modified_ts_start": null,
            "modified_ts_end": null,
            "uuid": null,
            "name": null,
            "status": null,
            "description": null
         },
         "allOf": [
            {
               "$ref": "#/definitions/V1ProjectFilters"
            }
         ]
      }
   },
   "required": [
      "page"
   ],
   "example": {
      "page": 1,
      "page_size": 100,
      "order": [
         {
            "field": "name",
            "direction": "DESC"
         }
      ],
      "search": "vianai",
      "filters": {
         "uuids": [
            "5efc9544-e84a-4a94-9e6d-5774e1c609ab",
            "9140dd05-3f7a-49a4-b625-379880bd9606"
         ],
         "names": [
            "Example project 1"
         ]
      }
   },
   "definitions": {
      "V1OrderBy": {
         "title": "V1OrderBy",
         "type": "object",
         "properties": {
            "field": {
               "title": "Field",
               "description": "Field to order by.",
               "type": "string"
            },
            "direction": {
               "title": "Direction",
               "description": "Direction to order the field by. Supported values: `ASC` (ascending) and `DESC` (descending) (case-insensitive).",
               "default": "ASC",
               "type": "string"
            }
         },
         "required": [
            "field"
         ]
      },
      "V1ProjectFilters": {
         "title": "V1ProjectFilters",
         "type": "object",
         "properties": {
            "created_by": {
               "title": "Created By",
               "description": "List of 'created by' users to search for.",
               "type": "array",
               "items": {
                  "type": "string"
               }
            },
            "modified_by": {
               "title": "Modified By",
               "description": "List of 'modified by' users to search for.",
               "type": "array",
               "items": {
                  "type": "string"
               }
            },
            "created_ts_start": {
               "title": "Created Ts Start",
               "description": "Unix time in milliseconds for searching for all objects created during a specified time period.",
               "type": "number"
            },
            "created_ts_end": {
               "title": "Created Ts End",
               "description": "Unix time in milliseconds for searching for all objects created during a specified time period.",
               "type": "number"
            },
            "modified_ts_start": {
               "title": "Modified Ts Start",
               "description": "Unix time in milliseconds for searching for all objects modified during a specified time period.",
               "type": "number"
            },
            "modified_ts_end": {
               "title": "Modified Ts End",
               "description": "Unix time in milliseconds for searching for all objects modified during a specified time period.",
               "type": "number"
            },
            "uuids": {
               "title": "Uuids",
               "description": "List of uuids for this operation.",
               "type": "array",
               "items": {
                  "type": "string"
               }
            },
            "names": {
               "title": "Names",
               "description": "List of names for this operation.",
               "type": "array",
               "items": {
                  "type": "string"
               }
            },
            "statuses": {
               "title": "Statuses",
               "description": "List of statuses for this operation.",
               "type": "array",
               "items": {
                  "type": "string"
               }
            },
            "descriptions": {
               "title": "Descriptions",
               "description": "List of project descriptions for this operation.",
               "type": "array",
               "items": {
                  "type": "string"
               }
            }
         },
         "example": {
            "uuids": [
               "5efc9544-e84a-4a94-9e6d-5774e1c609ab",
               "9140dd05-3f7a-49a4-b625-379880bd9606"
            ],
            "names": [
               "Example project"
            ]
         }
      }
   }
}

Config:
  • schema_extra: dict = {‘example’: {‘page’: 1, ‘page_size’: 100, ‘order’: [{‘field’: ‘name’, ‘direction’: ‘DESC’}], ‘search’: ‘vianai’, ‘filters’: {‘uuids’: [‘5efc9544-e84a-4a94-9e6d-5774e1c609ab’, ‘9140dd05-3f7a-49a4-b625-379880bd9606’], ‘names’: [‘Example project 1’]}}}

Fields:
field filters: V1ProjectFilters | None = V1ProjectFilters(created_by=None, modified_by=None, created_ts_start=None, created_ts_end=None, modified_ts_start=None, modified_ts_end=None, uuid=None, name=None, status=None, description=None)

Specifies different condition(s) for filtering the results. If not provided, all relevant results are retrieved.

pydantic model V1ProjectUpdates

Bases: V1BaseProject

Show JSON schema
{
   "title": "V1ProjectUpdates",
   "type": "object",
   "properties": {
      "name": {
         "title": "Name",
         "description": "name of the project",
         "type": "string"
      },
      "description": {
         "title": "Description",
         "description": "project description",
         "type": "string"
      },
      "status": {
         "title": "Status",
         "description": "project status",
         "type": "string"
      },
      "parent_project_uuid": {
         "title": "Parent Project Uuid",
         "description": "parent project id",
         "type": "string"
      },
      "created_ts": {
         "title": "Created Ts",
         "description": "Unix time in milliseconds generated at creation time.",
         "type": "string",
         "format": "date-time"
      },
      "modified_ts": {
         "title": "Modified Ts",
         "description": "Unix time in milliseconds generated at last modification time.",
         "type": "string",
         "format": "date-time"
      },
      "created_by": {
         "title": "Created By",
         "description": "user that created the project",
         "type": "string"
      },
      "modified_by": {
         "title": "Modified By",
         "description": "user that modified the project",
         "type": "string"
      },
      "filters": {
         "title": "Filters",
         "description": "Specifies different condition(s) for filtering the results. If not provided, all relevant results are retrieved.",
         "allOf": [
            {
               "$ref": "#/definitions/V1ProjectFilters"
            }
         ]
      }
   },
   "example": {
      "description": "new description",
      "status": "New project status",
      "filters": {
         "uuids": [
            "5efc9544-e84a-4a94-9e6d-5774e1c609ab",
            "9140dd05-3f7a-49a4-b625-379880bd9606"
         ],
         "names": [
            "Example project"
         ]
      }
   },
   "definitions": {
      "V1ProjectFilters": {
         "title": "V1ProjectFilters",
         "type": "object",
         "properties": {
            "created_by": {
               "title": "Created By",
               "description": "List of 'created by' users to search for.",
               "type": "array",
               "items": {
                  "type": "string"
               }
            },
            "modified_by": {
               "title": "Modified By",
               "description": "List of 'modified by' users to search for.",
               "type": "array",
               "items": {
                  "type": "string"
               }
            },
            "created_ts_start": {
               "title": "Created Ts Start",
               "description": "Unix time in milliseconds for searching for all objects created during a specified time period.",
               "type": "number"
            },
            "created_ts_end": {
               "title": "Created Ts End",
               "description": "Unix time in milliseconds for searching for all objects created during a specified time period.",
               "type": "number"
            },
            "modified_ts_start": {
               "title": "Modified Ts Start",
               "description": "Unix time in milliseconds for searching for all objects modified during a specified time period.",
               "type": "number"
            },
            "modified_ts_end": {
               "title": "Modified Ts End",
               "description": "Unix time in milliseconds for searching for all objects modified during a specified time period.",
               "type": "number"
            },
            "uuids": {
               "title": "Uuids",
               "description": "List of uuids for this operation.",
               "type": "array",
               "items": {
                  "type": "string"
               }
            },
            "names": {
               "title": "Names",
               "description": "List of names for this operation.",
               "type": "array",
               "items": {
                  "type": "string"
               }
            },
            "statuses": {
               "title": "Statuses",
               "description": "List of statuses for this operation.",
               "type": "array",
               "items": {
                  "type": "string"
               }
            },
            "descriptions": {
               "title": "Descriptions",
               "description": "List of project descriptions for this operation.",
               "type": "array",
               "items": {
                  "type": "string"
               }
            }
         },
         "example": {
            "uuids": [
               "5efc9544-e84a-4a94-9e6d-5774e1c609ab",
               "9140dd05-3f7a-49a4-b625-379880bd9606"
            ],
            "names": [
               "Example project"
            ]
         }
      }
   }
}

Config:
  • schema_extra: dict = {‘example’: {‘description’: ‘new description’, ‘status’: ‘New project status’, ‘filters’: {‘uuids’: [‘5efc9544-e84a-4a94-9e6d-5774e1c609ab’, ‘9140dd05-3f7a-49a4-b625-379880bd9606’], ‘names’: [‘Example project’]}}}

Fields:
field filters: V1ProjectFilters | None = None

Specifies different condition(s) for filtering the results. If not provided, all relevant results are retrieved.

pydantic model V1ProjectsPage

Bases: V1PageModel

Show JSON schema
{
   "title": "V1ProjectsPage",
   "type": "object",
   "properties": {
      "items": {
         "title": "Items",
         "description": "Projects returned by search in page.",
         "default": [],
         "type": "array",
         "items": {
            "$ref": "#/definitions/V1Project"
         }
      },
      "current_page": {
         "title": "Current Page",
         "description": "Current page of items.",
         "default": 0,
         "type": "integer"
      },
      "page_size": {
         "title": "Page Size",
         "description": "Number of items on a page.",
         "default": 0,
         "type": "integer"
      },
      "previous_page": {
         "title": "Previous Page",
         "description": "Number of the previous page.",
         "type": "integer"
      },
      "next_page": {
         "title": "Next Page",
         "description": "Number of the next page.",
         "type": "integer"
      },
      "has_previous": {
         "title": "Has Previous",
         "description": "Whether or not there is a previous page.",
         "default": false,
         "type": "boolean"
      },
      "previous_items": {
         "title": "Previous Items",
         "default": 0,
         "type": "integer"
      },
      "has_next": {
         "title": "Has Next",
         "description": "Whether or not there is a next page.",
         "default": false,
         "type": "boolean"
      },
      "total": {
         "title": "Total",
         "description": "Total number of items returned by search over all pages.",
         "default": 0,
         "type": "integer"
      },
      "pages": {
         "title": "Pages",
         "description": "Total number of pages returned by search.",
         "default": 0,
         "type": "integer"
      }
   },
   "example": {
      "items": [
         {
            "uuid": "5efc9544-e84a-4a94-9e6d-5774e1c609ab",
            "name": "Example project",
            "description": "project description",
            "status": "active",
            "created_ts": 1675251260780.042,
            "modified_ts": null,
            "created_by": "user1",
            "modified_by": "user2"
         }
      ],
      "current_page": 1,
      "page_size": 100,
      "previous_page": null,
      "next_page": null,
      "has_previous": false,
      "previous_items": 0,
      "has_next": false,
      "total": 1,
      "pages": 1
   },
   "definitions": {
      "V1Project": {
         "title": "V1Project",
         "type": "object",
         "properties": {
            "name": {
               "title": "Name",
               "description": "name of the project",
               "type": "string"
            },
            "description": {
               "title": "Description",
               "description": "project description",
               "type": "string"
            },
            "status": {
               "title": "Status",
               "description": "project status",
               "type": "string"
            },
            "parent_project_uuid": {
               "title": "Parent Project Uuid",
               "description": "parent project id",
               "type": "string"
            },
            "created_ts": {
               "title": "Created Ts",
               "description": "Unix time in milliseconds generated at creation time.",
               "type": "string",
               "format": "date-time"
            },
            "modified_ts": {
               "title": "Modified Ts",
               "description": "Unix time in milliseconds generated at last modification time.",
               "type": "string",
               "format": "date-time"
            },
            "created_by": {
               "title": "Created By",
               "description": "user that created the project",
               "type": "string"
            },
            "modified_by": {
               "title": "Modified By",
               "description": "user that modified the project",
               "type": "string"
            },
            "uuid": {
               "title": "Uuid",
               "description": "uuid of the project",
               "type": "string"
            }
         },
         "required": [
            "name"
         ],
         "example": {
            "uuid": "0",
            "name": "Example Project",
            "description": "project description",
            "status": "active",
            "parent_project_uuid": "0",
            "created_ts": 1675292368,
            "modified_ts": 1675292368,
            "created_by": "user1",
            "modified_by": "user1"
         }
      }
   }
}

Config:
  • schema_extra: dict = {‘example’: {‘items’: [{‘uuid’: ‘5efc9544-e84a-4a94-9e6d-5774e1c609ab’, ‘name’: ‘Example project’, ‘description’: ‘project description’, ‘status’: ‘active’, ‘created_ts’: 1675251260780.042, ‘modified_ts’: None, ‘created_by’: ‘user1’, ‘modified_by’: ‘user2’}], ‘current_page’: 1, ‘page_size’: 100, ‘previous_page’: None, ‘next_page’: None, ‘has_previous’: False, ‘previous_items’: 0, ‘has_next’: False, ‘total’: 1, ‘pages’: 1}}

Fields:
field items: List[V1Project] = []

Projects returned by search in page.

vianops_client.models.userservice.userpreference

pydantic model V1GetValueModel

Bases: BaseModel

Show JSON schema
{
   "title": "V1GetValueModel",
   "type": "object",
   "properties": {
      "value": {
         "title": "Value",
         "type": "string"
      }
   },
   "required": [
      "value"
   ]
}

Fields:
field value: str [Required]
pydantic model V1TableUpdatesBody

Bases: BaseModel

Show JSON schema
{
   "title": "V1TableUpdatesBody",
   "type": "object",
   "properties": {
      "tableUpdates": {
         "title": "Tableupdates",
         "type": "array",
         "items": {
            "$ref": "#/definitions/V1TableUpdatesListObject"
         }
      }
   },
   "required": [
      "tableUpdates"
   ],
   "definitions": {
      "V1TableUpdatesListObject": {
         "title": "V1TableUpdatesListObject",
         "type": "object",
         "properties": {
            "id": {
               "title": "Id",
               "type": "integer"
            },
            "column": {
               "title": "Column",
               "type": "string"
            },
            "new_value": {
               "title": "New Value",
               "type": "string"
            }
         },
         "required": [
            "id",
            "column",
            "new_value"
         ]
      }
   }
}

Fields:
field tableUpdates: List[V1TableUpdatesListObject] [Required]
pydantic model V1TableUpdatesListObject

Bases: BaseModel

Show JSON schema
{
   "title": "V1TableUpdatesListObject",
   "type": "object",
   "properties": {
      "id": {
         "title": "Id",
         "type": "integer"
      },
      "column": {
         "title": "Column",
         "type": "string"
      },
      "new_value": {
         "title": "New Value",
         "type": "string"
      }
   },
   "required": [
      "id",
      "column",
      "new_value"
   ]
}

Fields:
field column: str [Required]
field id: int [Required]
field new_value: str [Required]
pydantic model V1UserPreferenceBody

Bases: BaseModel

Show JSON schema
{
   "title": "V1UserPreferenceBody",
   "type": "object",
   "properties": {
      "system": {
         "title": "System",
         "type": "string"
      },
      "module": {
         "title": "Module",
         "type": "string"
      },
      "name": {
         "title": "Name",
         "type": "string"
      },
      "value": {
         "title": "Value",
         "type": "string"
      },
      "description": {
         "title": "Description",
         "type": "string"
      }
   },
   "required": [
      "system",
      "module",
      "name",
      "value",
      "description"
   ]
}

Fields:
field description: str [Required]
field module: str [Required]
field name: str [Required]
field system: str [Required]
field value: str [Required]
pydantic model V1UserPreferenceDeleteRow

Bases: BaseModel

Show JSON schema
{
   "title": "V1UserPreferenceDeleteRow",
   "type": "object",
   "properties": {
      "id": {
         "title": "Id",
         "type": "integer"
      }
   },
   "required": [
      "id"
   ]
}

Fields:
field id: int [Required]
pydantic model V1UserPreferenceGetValueModelRequest

Bases: BaseModel

Show JSON schema
{
   "title": "V1UserPreferenceGetValueModelRequest",
   "type": "object",
   "properties": {
      "system": {
         "title": "System",
         "type": "string"
      },
      "module": {
         "title": "Module",
         "type": "string"
      },
      "name": {
         "title": "Name",
         "type": "string"
      }
   },
   "required": [
      "system",
      "module",
      "name"
   ]
}

Fields:
field module: str [Required]
field name: str [Required]
field system: str [Required]
pydantic model V1UserPreferenceList

Bases: BaseModel

Show JSON schema
{
   "title": "V1UserPreferenceList",
   "type": "object",
   "properties": {
      "table": {
         "title": "Table",
         "type": "array",
         "items": {
            "$ref": "#/definitions/V1UserPreferenceModel"
         }
      }
   },
   "required": [
      "table"
   ],
   "definitions": {
      "V1UserPreferenceModel": {
         "title": "V1UserPreferenceModel",
         "type": "object",
         "properties": {
            "system": {
               "title": "System",
               "type": "string"
            },
            "module": {
               "title": "Module",
               "type": "string"
            },
            "name": {
               "title": "Name",
               "type": "string"
            },
            "value": {
               "title": "Value",
               "type": "string"
            },
            "description": {
               "title": "Description",
               "type": "string"
            },
            "id": {
               "title": "Id",
               "type": "integer"
            },
            "userid": {
               "title": "Userid",
               "type": "string"
            }
         },
         "required": [
            "system",
            "module",
            "name",
            "value",
            "description",
            "id",
            "userid"
         ]
      }
   }
}

Fields:
field table: List[V1UserPreferenceModel] [Required]
pydantic model V1UserPreferenceModel

Bases: V1UserPreferenceBody

Show JSON schema
{
   "title": "V1UserPreferenceModel",
   "type": "object",
   "properties": {
      "system": {
         "title": "System",
         "type": "string"
      },
      "module": {
         "title": "Module",
         "type": "string"
      },
      "name": {
         "title": "Name",
         "type": "string"
      },
      "value": {
         "title": "Value",
         "type": "string"
      },
      "description": {
         "title": "Description",
         "type": "string"
      },
      "id": {
         "title": "Id",
         "type": "integer"
      },
      "userid": {
         "title": "Userid",
         "type": "string"
      }
   },
   "required": [
      "system",
      "module",
      "name",
      "value",
      "description",
      "id",
      "userid"
   ]
}

Fields:
field id: int [Required]
field userid: str [Required]