SegmentationSession

SegmentationSession
Segmentation Session

Represents a segmentation session. A session encapsulates the entire workflow of uploading a CSV file, analyzing network data, and generating segmentation recommendations. Extends ManagedResource to inherit standard resource properties (id, display_name, description, timestamps, etc.).

Notes:

  • Only the action field is writable on PUT; all other fields including those inherited from ManagedResource are read-only and will be ignored.
  • The _revision field must be supplied on every PUT for optimistic locking; the server auto-increments it.
  • The status field reflects the most recent lifecycle outcome and is read-only.
AllOf
This class requires all of the following:
JSON Example
{
    "_create_user": "admin",
    "_create_time": 1781138986293,
    "_last_modified_user": "admin",
    "_last_modified_time": 1781138986293,
    "_revision": 0,
    "_resource_type": "string",
    "_system_owned": false,
    "id": "f4a7eb15-43c4-44cb-ac5c-8a5d5c15235b",
    "display_name": "session_f4a7eb15-43c4-44cb-ac5c-8a5d5c15235b",
    "description": "string",
    "site_ids": [],
    "action": "NONE",
    "status": {
        "status": "FILE_READY_TO_PARSE",
        "progress_percent": 0,
        "error_messages": [],
        "parsing_error_count": 0
    }
}