Project Design Data Classes
reptor.models.ProjectDesign.ProjectDesign
Project design template with incl. field definitions and default values.
Attributes:
-
id
(str
) –Project design ID (uuid).
-
created
(datetime
) –Date when the project design was created.
-
updated
(datetime
) –Date when the project design was last updated.
-
source
(str
) –Source of the project design. Possible values:
created
,imported
,imported_dependecy
,customized
,snapshot
. -
scope
(str
) –Scope of the project design (e.g., "global", "user").
-
name
(str
) –Project design name.
-
tags
(List[str]
) –List of tags associated with the project design.
-
language
(str
) –Language code for the project design (e.g., "en-US").
-
usage_count
(int
) –Counts how often the project design has been assigned to a project.
-
details
(str
) –Project design details API endpoint (URL).
-
assets
(str
) –Project design assets API endpoint (URL).
-
copy_of
(str
) –ID of the original project design this is a copy of (if any).
-
finding_fields
(List[ProjectDesignField]
) –List of field definitions for findings.
-
report_fields
(List[ProjectDesignField]
) –List of field definitions for report sections (derived from
report_sections
received from the API).
Methods:
-
to_dict
–Convert to a dictionary representation.
reptor.models.ProjectDesign.ProjectDesignOverview
ProjectDesignOverview
has the same base attributes as ProjectDesign
, except for copy_of
, report_fields
and finding_fields
.
Attributes:
-
id
(str
) –Project design ID (uuid).
-
created
(datetime
) –Date when the project design was created.
-
updated
(datetime
) –Date when the project design was last updated.
-
source
(str
) –Source of the project design. Possible values:
created
,imported
,imported_dependecy
,customized
,snapshot
. -
scope
(str
) –Scope of the project design (e.g., "global", "user").
-
name
(str
) –Project design name.
-
tags
(List[str]
) –List of tags associated with the project design.
-
language
(str
) –Language code for the project design (e.g., "en-US").
-
usage_count
(int
) –Counts how often the project design has been assigned to a project.
-
details
(str
) –Project design details API endpoint (URL).
-
assets
(str
) –Project design assets API endpoint (URL).
Methods:
-
to_dict
–Convert to a dictionary representation.
reptor.models.ProjectDesign.ProjectDesignField
dataclass
Represents a field definition in a project design template.
Attributes:
-
id
(str
) –Field identifier/name.
-
type
(ProjectFieldTypes
) –Field type (string, enum, list, object, etc.).
-
label
(str
) –Human-readable field label.
-
origin
(str
) –Source origin of the field.
-
default
(str
) –Default value for the field.
-
required
(bool
) –Whether the field is required.
-
spellcheck
(bool
) –Whether spellcheck is enabled for this field.
-
properties
(Any
) –Nested field properties for object types.
-
choices
(List[dict]
) –Available choices for enum fields.
-
items
(dict
) –Item definition for list fields.
-
suggestions
(List[str]
) –List of suggested values for the field.
-
pattern
(str
) –Regular expression pattern for validation (used for fields in project designs).
-
help_text
(str
) –Help text for the field.
Methods:
-
to_dict
–Convert to a dictionary representation.