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:
BaseModelShow JSON schema
{ "title": "V1BaseProject", "type": "object", "properties": { "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "name of the project", "title": "Name" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "project description", "title": "Description" }, "status": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "project status", "title": "Status" }, "parent_project_uuid": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "parent project id", "title": "Parent Project Uuid" }, "created_ts": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "default": null, "description": "Unix time in milliseconds generated at creation time.", "title": "Created Ts" }, "modified_ts": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "default": null, "description": "Unix time in milliseconds generated at last modification time.", "title": "Modified Ts" }, "created_by": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "user that created the project", "title": "Created By" }, "modified_by": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "user that modified the project", "title": "Modified By" } }, "example": { "created_by": "user1", "created_ts": 1675292368, "description": "project description", "modified_by": "user1", "modified_ts": 1675292368, "parent_project_uuid": "0", "status": "active" } }
- Config:
from_attributes: bool = True
json_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:
V1BaseProjectShow JSON schema
{ "title": "V1Project", "type": "object", "properties": { "name": { "description": "name of the project", "title": "Name", "type": "string" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "project description", "title": "Description" }, "status": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "project status", "title": "Status" }, "parent_project_uuid": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "parent project id", "title": "Parent Project Uuid" }, "created_ts": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "default": null, "description": "Unix time in milliseconds generated at creation time.", "title": "Created Ts" }, "modified_ts": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "default": null, "description": "Unix time in milliseconds generated at last modification time.", "title": "Modified Ts" }, "created_by": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "user that created the project", "title": "Created By" }, "modified_by": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "user that modified the project", "title": "Modified By" }, "uuid": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "uuid of the project", "title": "Uuid" } }, "example": { "created_by": "user1", "created_ts": 1675292368, "description": "project description", "modified_by": "user1", "modified_ts": 1675292368, "name": "Example Project", "parent_project_uuid": "0", "status": "active", "uuid": "0" }, "required": [ "name" ] }
- Config:
from_attributes: bool = True
json_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:
V1FiltersShow JSON schema
{ "title": "V1ProjectFilters", "type": "object", "properties": { "created_by": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "List of 'created by' users to search for.", "title": "Created By" }, "modified_by": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "List of 'modified by' users to search for.", "title": "Modified By" }, "created_ts_start": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "default": null, "description": "Unix time in milliseconds for searching for all objects created during a specified time period.", "title": "Created Ts Start" }, "created_ts_end": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "default": null, "description": "Unix time in milliseconds for searching for all objects created during a specified time period.", "title": "Created Ts End" }, "modified_ts_start": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "default": null, "description": "Unix time in milliseconds for searching for all objects modified during a specified time period.", "title": "Modified Ts Start" }, "modified_ts_end": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "default": null, "description": "Unix time in milliseconds for searching for all objects modified during a specified time period.", "title": "Modified Ts End" }, "uuids": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "List of uuids for this operation.", "title": "Uuids" }, "names": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "List of names for this operation.", "title": "Names" }, "statuses": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "List of statuses for this operation.", "title": "Statuses" }, "descriptions": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "List of project descriptions for this operation.", "title": "Descriptions" } }, "examples": [ { "names": [ "Example project" ], "uuids": [ "5efc9544-e84a-4a94-9e6d-5774e1c609ab", "9140dd05-3f7a-49a4-b625-379880bd9606" ] } ] }
- Config:
populate_by_name: bool = True
alias_generator: function = <function V1ProjectFilters.<lambda> at 0x7f98f1673a60>
json_schema_extra: dict = {‘examples’: [{‘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:
RootModelShow JSON schema
{ "title": "V1ProjectList", "type": "array", "$defs": { "V1Project": { "example": { "created_by": "user1", "created_ts": 1675292368, "description": "project description", "modified_by": "user1", "modified_ts": 1675292368, "name": "Example Project", "parent_project_uuid": "0", "status": "active", "uuid": "0" }, "properties": { "name": { "description": "name of the project", "title": "Name", "type": "string" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "project description", "title": "Description" }, "status": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "project status", "title": "Status" }, "parent_project_uuid": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "parent project id", "title": "Parent Project Uuid" }, "created_ts": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "default": null, "description": "Unix time in milliseconds generated at creation time.", "title": "Created Ts" }, "modified_ts": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "default": null, "description": "Unix time in milliseconds generated at last modification time.", "title": "Modified Ts" }, "created_by": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "user that created the project", "title": "Created By" }, "modified_by": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "user that modified the project", "title": "Modified By" }, "uuid": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "uuid of the project", "title": "Uuid" } }, "required": [ "name" ], "title": "V1Project", "type": "object" } }, "items": { "$ref": "#/$defs/V1Project" } }
- pydantic model V1ProjectSearch
Bases:
V1PageSearchShow JSON schema
{ "title": "V1ProjectSearch", "type": "object", "properties": { "page": { "default": 1, "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`).", "title": "Page", "type": "integer" }, "page_size": { "default": 25, "description": "Number of items to return on a page. Default is 25 items per page.", "title": "Page Size", "type": "integer" }, "order": { "anyOf": [ { "items": { "$ref": "#/$defs/V1OrderBy" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "Fields to use for ordering returned pages and the sort direction.", "title": "Order" }, "search": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "String to search for (case-insensitive) across all fields in previously created items.", "title": "Search" }, "filters": { "anyOf": [ { "$ref": "#/$defs/V1ProjectFilters" }, { "type": "null" } ], "description": "Specifies different condition(s) for filtering the results. If not provided, all relevant results are retrieved." } }, "$defs": { "V1OrderBy": { "properties": { "field": { "description": "Field to order by.", "title": "Field", "type": "string" }, "direction": { "default": "ASC", "description": "Direction to order the field by. Supported values: `ASC` (ascending) and `DESC` (descending) (case-insensitive).", "enum": [ "ASC", "DESC" ], "title": "Direction", "type": "string" } }, "required": [ "field" ], "title": "V1OrderBy", "type": "object" }, "V1ProjectFilters": { "examples": [ { "names": [ "Example project" ], "uuids": [ "5efc9544-e84a-4a94-9e6d-5774e1c609ab", "9140dd05-3f7a-49a4-b625-379880bd9606" ] } ], "properties": { "created_by": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "List of 'created by' users to search for.", "title": "Created By" }, "modified_by": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "List of 'modified by' users to search for.", "title": "Modified By" }, "created_ts_start": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "default": null, "description": "Unix time in milliseconds for searching for all objects created during a specified time period.", "title": "Created Ts Start" }, "created_ts_end": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "default": null, "description": "Unix time in milliseconds for searching for all objects created during a specified time period.", "title": "Created Ts End" }, "modified_ts_start": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "default": null, "description": "Unix time in milliseconds for searching for all objects modified during a specified time period.", "title": "Modified Ts Start" }, "modified_ts_end": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "default": null, "description": "Unix time in milliseconds for searching for all objects modified during a specified time period.", "title": "Modified Ts End" }, "uuids": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "List of uuids for this operation.", "title": "Uuids" }, "names": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "List of names for this operation.", "title": "Names" }, "statuses": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "List of statuses for this operation.", "title": "Statuses" }, "descriptions": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "List of project descriptions for this operation.", "title": "Descriptions" } }, "title": "V1ProjectFilters", "type": "object" } }, "example": { "filters": { "names": [ "Example project 1" ], "uuids": [ "5efc9544-e84a-4a94-9e6d-5774e1c609ab", "9140dd05-3f7a-49a4-b625-379880bd9606" ] }, "order": [ { "direction": "DESC", "field": "name" } ], "page": 1, "page_size": 100, "search": "vianai" } }
- Config:
json_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 [Optional]
Specifies different condition(s) for filtering the results. If not provided, all relevant results are retrieved.
- pydantic model V1ProjectUpdates
Bases:
V1BaseProjectShow JSON schema
{ "title": "V1ProjectUpdates", "type": "object", "properties": { "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "name of the project", "title": "Name" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "project description", "title": "Description" }, "status": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "project status", "title": "Status" }, "parent_project_uuid": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "parent project id", "title": "Parent Project Uuid" }, "created_ts": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "default": null, "description": "Unix time in milliseconds generated at creation time.", "title": "Created Ts" }, "modified_ts": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "default": null, "description": "Unix time in milliseconds generated at last modification time.", "title": "Modified Ts" }, "created_by": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "user that created the project", "title": "Created By" }, "modified_by": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "user that modified the project", "title": "Modified By" }, "filters": { "anyOf": [ { "$ref": "#/$defs/V1ProjectFilters" }, { "type": "null" } ], "default": null, "description": "Specifies different condition(s) for filtering the results. If not provided, all relevant results are retrieved." } }, "$defs": { "V1ProjectFilters": { "examples": [ { "names": [ "Example project" ], "uuids": [ "5efc9544-e84a-4a94-9e6d-5774e1c609ab", "9140dd05-3f7a-49a4-b625-379880bd9606" ] } ], "properties": { "created_by": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "List of 'created by' users to search for.", "title": "Created By" }, "modified_by": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "List of 'modified by' users to search for.", "title": "Modified By" }, "created_ts_start": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "default": null, "description": "Unix time in milliseconds for searching for all objects created during a specified time period.", "title": "Created Ts Start" }, "created_ts_end": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "default": null, "description": "Unix time in milliseconds for searching for all objects created during a specified time period.", "title": "Created Ts End" }, "modified_ts_start": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "default": null, "description": "Unix time in milliseconds for searching for all objects modified during a specified time period.", "title": "Modified Ts Start" }, "modified_ts_end": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "default": null, "description": "Unix time in milliseconds for searching for all objects modified during a specified time period.", "title": "Modified Ts End" }, "uuids": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "List of uuids for this operation.", "title": "Uuids" }, "names": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "List of names for this operation.", "title": "Names" }, "statuses": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "List of statuses for this operation.", "title": "Statuses" }, "descriptions": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "List of project descriptions for this operation.", "title": "Descriptions" } }, "title": "V1ProjectFilters", "type": "object" } }, "example": { "description": "new description", "filters": { "names": [ "Example project" ], "uuids": [ "5efc9544-e84a-4a94-9e6d-5774e1c609ab", "9140dd05-3f7a-49a4-b625-379880bd9606" ] }, "status": "New project status" } }
- Config:
from_attributes: bool = True
json_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:
V1PageModelShow JSON schema
{ "title": "V1ProjectsPage", "type": "object", "properties": { "items": { "default": [], "description": "Projects returned by search in page.", "items": { "$ref": "#/$defs/V1Project" }, "title": "Items", "type": "array" }, "current_page": { "default": 0, "description": "Current page of items.", "title": "Current Page", "type": "integer" }, "page_size": { "default": 0, "description": "Number of items on a page.", "title": "Page Size", "type": "integer" }, "previous_page": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Number of the previous page.", "title": "Previous Page" }, "next_page": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Number of the next page.", "title": "Next Page" }, "has_previous": { "default": false, "description": "Whether or not there is a previous page.", "title": "Has Previous", "type": "boolean" }, "previous_items": { "default": 0, "title": "Previous Items", "type": "integer" }, "has_next": { "default": false, "description": "Whether or not there is a next page.", "title": "Has Next", "type": "boolean" }, "total": { "default": 0, "description": "Total number of items returned by search over all pages.", "title": "Total", "type": "integer" }, "pages": { "default": 0, "description": "Total number of pages returned by search.", "title": "Pages", "type": "integer" } }, "$defs": { "V1Project": { "example": { "created_by": "user1", "created_ts": 1675292368, "description": "project description", "modified_by": "user1", "modified_ts": 1675292368, "name": "Example Project", "parent_project_uuid": "0", "status": "active", "uuid": "0" }, "properties": { "name": { "description": "name of the project", "title": "Name", "type": "string" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "project description", "title": "Description" }, "status": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "project status", "title": "Status" }, "parent_project_uuid": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "parent project id", "title": "Parent Project Uuid" }, "created_ts": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "default": null, "description": "Unix time in milliseconds generated at creation time.", "title": "Created Ts" }, "modified_ts": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "default": null, "description": "Unix time in milliseconds generated at last modification time.", "title": "Modified Ts" }, "created_by": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "user that created the project", "title": "Created By" }, "modified_by": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "user that modified the project", "title": "Modified By" }, "uuid": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "uuid of the project", "title": "Uuid" } }, "required": [ "name" ], "title": "V1Project", "type": "object" } }, "example": { "current_page": 1, "has_next": false, "has_previous": false, "items": [ { "created_by": "user1", "created_ts": 1675251260780.042, "description": "project description", "modified_by": "user2", "modified_ts": null, "name": "Example project", "status": "active", "uuid": "5efc9544-e84a-4a94-9e6d-5774e1c609ab" } ], "next_page": null, "page_size": 100, "pages": 1, "previous_items": 0, "previous_page": null, "total": 1 } }
- Config:
json_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:
vianops_client.models.userservice.userpreference
- pydantic model V1GetValueModel
Bases:
BaseModelShow JSON schema
{ "title": "V1GetValueModel", "type": "object", "properties": { "value": { "title": "Value", "type": "string" } }, "required": [ "value" ] }
- Fields:
- field value: str [Required]
- pydantic model V1TableUpdatesBody
Bases:
BaseModelShow JSON schema
{ "title": "V1TableUpdatesBody", "type": "object", "properties": { "tableUpdates": { "items": { "$ref": "#/$defs/V1TableUpdatesListObject" }, "title": "Tableupdates", "type": "array" } }, "$defs": { "V1TableUpdatesListObject": { "properties": { "id": { "title": "Id", "type": "integer" }, "column": { "title": "Column", "type": "string" }, "new_value": { "title": "New Value", "type": "string" } }, "required": [ "id", "column", "new_value" ], "title": "V1TableUpdatesListObject", "type": "object" } }, "required": [ "tableUpdates" ] }
- Fields:
- field tableUpdates: List[V1TableUpdatesListObject] [Required]
- pydantic model V1TableUpdatesListObject
Bases:
BaseModelShow 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:
BaseModelShow 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" ] }
- field description: str [Required]
- field module: str [Required]
- field name: str [Required]
- field system: str [Required]
- field value: str [Required]
- pydantic model V1UserPreferenceDeleteRow
Bases:
BaseModelShow JSON schema
{ "title": "V1UserPreferenceDeleteRow", "type": "object", "properties": { "id": { "title": "Id", "type": "integer" } }, "required": [ "id" ] }
- Fields:
- field id: int [Required]
- pydantic model V1UserPreferenceGetValueModelRequest
Bases:
BaseModelShow JSON schema
{ "title": "V1UserPreferenceGetValueModelRequest", "type": "object", "properties": { "system": { "title": "System", "type": "string" }, "module": { "title": "Module", "type": "string" }, "name": { "title": "Name", "type": "string" }, "userid": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Userid" } }, "required": [ "system", "module", "name" ] }
- field module: str [Required]
- field name: str [Required]
- field system: str [Required]
- field userid: str | None = None
- pydantic model V1UserPreferenceList
Bases:
BaseModelShow JSON schema
{ "title": "V1UserPreferenceList", "type": "object", "properties": { "table": { "items": { "$ref": "#/$defs/V1UserPreferenceModel" }, "title": "Table", "type": "array" } }, "$defs": { "V1UserPreferenceModel": { "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" ], "title": "V1UserPreferenceModel", "type": "object" } }, "required": [ "table" ] }
- field table: List[V1UserPreferenceModel] [Required]
- pydantic model V1UserPreferenceModel
Bases:
V1UserPreferenceBodyShow 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]