InlineSegmentationSession1

JSON Example

{
    "action": "NONE",
    "_create_user": "admin",
    "_create_time": 1781138986293,
    "_last_modified_user": "admin",
    "_last_modified_time": 1781138986293,
    "_revision": 0,
    "id": "f4a7eb15-43c4-44cb-ac5c-8a5d5c15235b",
    "display_name": "session_f4a7eb15-43c4-44cb-ac5c-8a5d5c15235b",
    "site_ids": [],
    "status": {
        "status": "FILE_READY_TO_PARSE",
        "progress_percent": 0,
        "error_messages": [],
        "parsing_error_count": 0
    }
}

SegmentationSessionStatusInfo

status

Optional

Contains detailed status information for a segmentation session, including the current status, progress tracking, and any errors encountered during processing.

SegmentationSessionAction

action

Required

Action to perform on a segmentation session.

NONE: No action (default state)
PARSE_FILE: Begin parsing the uploaded CSV file
START_ANALYSIS: Start network analysis and recommendation generation
RERUN_ANALYSIS: Rerun the analysis with updated parameters
CANCEL_ANALYSIS: Cancel the currently running analysis

Notes:

PARSE_FILE requires status to be FILE_VALIDATED or FILE_READY_TO_PARSE; configure CSV column mappings via PUT /{session-id}/settings first.
START_ANALYSIS requires status to be FILE_PARSED; it clears any previously generated proposed objects and policies.
RERUN_ANALYSIS has the same prerequisites as START_ANALYSIS and is used to re-run analysis without re-uploading the CSV.
CANCEL_ANALYSIS is only accepted when status is ANALYSIS_IN_PROGRESS.

Enumeration: NONE, PARSE_FILE, START_ANALYSIS, RERUN_ANALYSIS, CANCEL_ANALYSIS

array of CsvFile

output_files

Read-Only

List of output files for this session (one per file type). Each entry contains the file name.

Used By

SegmentationSession