Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
Types ¶
type Input ¶
type Input struct {
// Direct lookups (single result; mutually exclusive; not combinable with filters).
AssessmentID string `` /* 194-byte string literal not displayed */
AssessmentReviewID string `` /* 196-byte string literal not displayed */
// Filters (combinable; return a list).
Name string `` /* 132-byte string literal not displayed */
Status string `json:"status,omitempty" jsonschema:"Filter: DRAFT, SUBMITTED, or OBSOLETE."`
TemplateID string `json:"templateId,omitempty" jsonschema:"Filter: UUID of the template the assessment was created from."`
TemplateVersion string `` /* 134-byte string literal not displayed */
AssetID string `json:"assetId,omitempty" jsonschema:"Filter: UUID of the asset the assessment was conducted on."`
LastModifiedFrom string `` /* 163-byte string literal not displayed */
LastModifiedTo string `json:"lastModifiedTo,omitempty" jsonschema:"Filter: ISO-8601 timestamp; include assessments last modified before this time."`
Limit int `json:"limit,omitempty" jsonschema:"Filter: max results to return (1-50, default 10)."`
Cursor string `json:"cursor,omitempty" jsonschema:"Filter: pagination cursor from a previous response's nextCursor."`
}
Input has two modes. A DIRECT lookup (assessmentId or assessmentReviewId) fetches a single assessment and can't be combined with anything else. A FILTERED lookup uses any combination of the remaining fields and returns a list (paginated). With no fields set it lists the assessments you can see.
type Output ¶
type Output struct {
// Assessment is set for a direct lookup, or a filtered lookup with exactly one match.
Assessment *clients.Assessment `` /* 342-byte string literal not displayed */
// Assessments is set for a filtered lookup that matches more than one.
Assessments []clients.Assessment `` /* 161-byte string literal not displayed */
NextCursor string `` /* 136-byte string literal not displayed */
Error string `json:"error,omitempty" jsonschema:"error message if no assessment was found or an API error occurred"`
Found bool `json:"found" jsonschema:"whether at least one assessment was found"`
}
Click to show internal directories.
Click to hide internal directories.