SegmentationObjectListResult

Paginated response containing segmentation objects and any system-wide inventory alerts.

Notes:

results is a polymorphic array of SegmentationObject subtypes; the concrete type of each entry is identified by its segmentation_type field.
inventory_alerts contains system-wide alerts (e.g., approaching count limits) that are not tied to individual objects.
Pagination metadata is inherited from ListResult.

AllOf

This class requires all of the following:

JSON Example

{
    "offset": 0,
    "number_of_results": 2,
    "total_result_count": 2,
    "total_pages": 1,
    "sort_ascending": true,
    "sort_by": "display_name",
    "results": [
        {
            "id": "app-001",
            "display_name": "US_NewYork_Production_ECommerce",
            "segmentation_type": "APPLICATION",
            "application_type": "CRITICAL",
            "flow_prioritization_enabled": true,
            "num_tiers": 3,
            "num_out_of_sync_tiers": 0,
            "num_timed_out_tiers": 0,
            "status": "SUCCESS",
            "application_alerts": [],
            "hierarchy": [
                {
                    "scope": "Region",
                    "value": "US",
                    "level": 0
                },
                {
                    "scope": "Zone",
                    "value": "NewYork",
                    "level": 1
                },
                {
                    "scope": "Environment",
                    "value": "Production",
                    "level": 2
                },
                {
                    "scope": "Application",
                    "value": "ECommerce",
                    "level": 3
                }
            ],
            "realization_groups": [
                {
                    "display_name": "US_NewYork_Production_ECommerce",
                    "site_id": "a1b2c3d4-e5f6-7890-1234-567890abcdef",
                    "realization_id": "b2c3d4e5-f6a7-8901-2345-678901bcdefg",
                    "status": "SUCCESS",
                    "policy_path": "/infra/domains/default/groups/app-001",
                    "tags": [
                        {
                            "scope": "Region",
                            "tag": "US"
                        },
                        {
                            "scope": "Zone",
                            "tag": "NewYork"
                        },
                        {
                            "scope": "Environment",
                            "tag": "Production"
                        },
                        {
                            "scope": "Application",
                            "tag": "ECommerce"
                        }
                    ]
                }
            ]
        },
        {
            "id": "env-001",
            "display_name": "US_NewYork_Production",
            "segmentation_type": "ENVIRONMENT",
            "num_applications": 5,
            "status": "SUCCESS",
            "environment_alerts": [],
            "hierarchy": [
                {
                    "scope": "Region",
                    "value": "US",
                    "level": 0
                },
                {
                    "scope": "Zone",
                    "value": "NewYork",
                    "level": 1
                },
                {
                    "scope": "Environment",
                    "value": "Production",
                    "level": 2
                }
            ],
            "realization_groups": [
                {
                    "display_name": "US_NewYork_Production",
                    "site_id": "a1b2c3d4-e5f6-7890-1234-567890abcdef",
                    "realization_id": "d5e6f7a8-b9c0-1234-5678-901234defabc",
                    "status": "SUCCESS",
                    "policy_path": "/infra/domains/default/groups/env-001",
                    "tags": [
                        {
                            "scope": "Region",
                            "tag": "US"
                        },
                        {
                            "scope": "Zone",
                            "tag": "NewYork"
                        },
                        {
                            "scope": "Environment",
                            "tag": "Production"
                        }
                    ]
                }
            ]
        }
    ],
    "inventory_alerts": []
}