bayesline.api.SaveItemResult

model SaveItemResult

The result of a single save operation.

Fields

Field	Type	Required	Default
id	int | None	Yes
message	str	No	''
name	str | None	Yes
name_or_id	str | int	Yes
short_message	str	No	''
status	ItemStatus	Yes

field id: int | None [Required]

The identifier of the item if available. Will always be available if the operation was successful.

field message: str [Optional]

The human readable message of the item’s operation result.

field name: str | None [Required]

The name of the item if available. Will always be available if the operation was successful.

field name_or_id: str | int [Required]

The name or identifier of the item as it was provided to the operation.

field short_message: str [Optional]

A short message of the item’s operation result which can be used for summary messages. E.g. if a user could not be found, the short message should be the input of the user that could not be found.

field status: ItemStatus [Required]

The status of the item operation.