Enterprise Get Enterprise Network Segments

Enterprise Get Enterprise Network Segments

Retrieve a list of all of the network segments defined forthe given enterprise.

Privileges required:

READ NETWORK_ALLOCATION

Request
URI
POST
https://{api_host}/portal/rest/enterprise/getEnterpriseNetworkSegments
COPY
Request Body
{
    "enterpriseId": 0,
    "name": "string",
    "type": "string",
    "with": [
        "string"
    ]
}
integer
enterpriseId
Optional

enterpriseId

string
name
Optional

name

string
type
Optional

type

array of string
with
Optional

with

Possible values are : profileCount, edgeUsage, configuration, handoffUsage, mpgUsage,
Responses
200

Request was successfully processed

[
    {
        "id": 0,
        "created": "string",
        "operatorId": 0,
        "networkId": 0,
        "enterpriseId": 0,
        "edgeId": 0,
        "gatewayId": 0,
        "parentGroupId": 0,
        "description": "string",
        "object": "string",
        "name": "string",
        "type": "string",
        "logicalId": "string",
        "alertsEnabled": 0,
        "operatorAlertsEnabled": 0,
        "status": "string",
        "statusModified": "string",
        "previousData": {},
        "previousCreated": "string",
        "draftData": "string",
        "draftCreated": "string",
        "draftComment": "string",
        "data": {
            "segmentId": 0,
            "serviceVlan": 0,
            "delegateToEnterprise": false,
            "delegateToEnterpriseProxy": false
        },
        "lastContact": "string",
        "version": "string",
        "modified": "string",
        "profileCount": 0,
        "handoffUsage": [
            {}
        ],
        "isAllMPGCDE": false,
        "isAllCtrlCDE": false,
        "edgeCount": 0,
        "edgeUsage": [
            {
                "configurationId": 0,
                "edgeSpecificId": 0,
                "name": "string",
                "logicalId": "string",
                "profileId": 0
            }
        ],
        "configuration": [
            {
                "id": 0,
                "created": "string",
                "name": "string",
                "logicalId": "string",
                "version": "string",
                "description": "string",
                "configurationType": "string",
                "schemaVersion": "string",
                "effective": "string",
                "modified": "string",
                "moduleId": 0,
                "segmentObjectId": 0
            }
        ]
    }
]
array of enterprise_get_enterprise_network_segments_result_item
Optional

400
Returns generic_400 of type(s) application/json
Operation doesn't return any data structure

500
Returns generic_500 of type(s) application/json
Operation doesn't return any data structure

Code Samples
COPY
                    curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{}' https://{api_host}/portal/rest/enterprise/getEnterpriseNetworkSegments
On This Page
All Operations
POST
Enterprise Get Enterprise Alert Definitions
POST
Enterprise Delete Enterprise
POST
Enterprise Delete Enterprise Gateway Records
POST
Enterprise Delete Enterprise Network Allocation
POST
Enterprise Delete Enterprise Network Segment
POST
Enterprise Delete Enterprise Service
POST
Enterprise Fix Superaltgateway
POST
Enterprise Get Enterprise Addresses
POST
Enterprise Get Enterprise Alert Configurations
POST
Enterprise Get Enterprise Alerts
POST
Enterprise Get Enterprise All Alert Recipients
POST
Enterprise Get Enterprise Configurations
POST
Enterprise Get Enterprise Network Allocations
POST
Enterprise Get Enterprise Network Segments
POST
Enterprise Get Enterprise Operator Configuration
POST
Enterprise Get Enterprise Route Configuration
POST
Enterprise Get Enterprise Route Table
POST
Enterprise Get Enterprise Services
POST
Enterprise Get Enterprises Missinggateway
POST
Enterprise Insert Enterprise Service
POST
Enterprise Insert Or Update Enterprise Alert Configurations
POST
Enterprise Set Enterprise All Alert Recipients
POST
Enterprise Set Enterprise Operator Configuration
POST
Enterprise Update Enterprise Route
POST
Enterprise Update Enterprise Route Configuration
POST
Enterprise Update Enterprise Service