Jump to

• Request
• Response

Get Traffic Control Data

get

ss/oc-cnpolicy-configuration/v1/policydata/pcfsm/trafficcontroldata/{trafficControlDataName}

Request

Path Parameters

• trafficControlDataName: string
  Traffic Control Data Name

Back to Top

Response

Supported Media Types

• application/json

200 Response

OK.Traffic Control Data is returned

Body ()

Root Schema : TrafficControlData

Type: object

Title: TrafficControlData

Show Source

• description(optional): string
• flowStatus(optional): string
  Allowed Values: [ "DISABLED", "ENABLED", "ENABLED-DOWNLINK", "ENABLED-UPLINK", "REMOVED" ]
• muteNotif(optional): boolean
• name: string
• redirectInfo(optional): object RedirectInfo
  Title: RedirectInfo
• routeToLocs(optional): array routeToLocs
• tcId: string
• trafficSteeringPolIdDl(optional): string
• trafficSteeringPolIdUl(optional): string
• upPathChgEvent(optional): object UpPathChgEvent
  Title: UpPathChgEvent

{
    "type":"object",
    "required":[
        "name",
        "tcId"
    ],
    "properties":{
        "description":{
            "type":"string"
        },
        "flowStatus":{
            "type":"string",
            "enum":[
                "DISABLED",
                "ENABLED",
                "ENABLED-DOWNLINK",
                "ENABLED-UPLINK",
                "REMOVED"
            ]
        },
        "muteNotif":{
            "type":"boolean"
        },
        "name":{
            "type":"string"
        },
        "redirectInfo":{
            "$ref":"#/definitions/RedirectInfo"
        },
        "routeToLocs":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/RouteToLocs"
            }
        },
        "tcId":{
            "type":"string"
        },
        "trafficSteeringPolIdDl":{
            "type":"string"
        },
        "trafficSteeringPolIdUl":{
            "type":"string"
        },
        "upPathChgEvent":{
            "$ref":"#/definitions/UpPathChgEvent"
        }
    },
    "title":"TrafficControlData"
}

Nested Schema : RedirectInfo

Type: object

Title: RedirectInfo

Show Source

• redirectAddressType(optional): string
  Allowed Values: [ "IPV4_ADDR", "IPV6_ADDR", "SIP_URI", "URL" ]
• redirectEnabled(optional): boolean
• redirectServerAddress(optional): string

{
    "type":"object",
    "properties":{
        "redirectAddressType":{
            "type":"string",
            "enum":[
                "IPV4_ADDR",
                "IPV6_ADDR",
                "SIP_URI",
                "URL"
            ]
        },
        "redirectEnabled":{
            "type":"boolean"
        },
        "redirectServerAddress":{
            "type":"string"
        }
    },
    "title":"RedirectInfo"
}

Nested Schema : routeToLocs

Type: array

Show Source

• Array of: object RouteToLocs
  Title: RouteToLocs

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/RouteToLocs"
    }
}

Nested Schema : UpPathChgEvent

Type: object

Title: UpPathChgEvent

Show Source

• dnaiChgType(optional): string
  Allowed Values: [ "EARLY", "EARLY_LATE", "LATE" ]
• notifCorreId(optional): string
• notificationUri(optional): string

{
    "type":"object",
    "properties":{
        "dnaiChgType":{
            "type":"string",
            "enum":[
                "EARLY",
                "EARLY_LATE",
                "LATE"
            ]
        },
        "notifCorreId":{
            "type":"string"
        },
        "notificationUri":{
            "type":"string"
        }
    },
    "title":"UpPathChgEvent"
}

Nested Schema : RouteToLocs

Type: object

Title: RouteToLocs

Show Source

• dnai(optional): string
• routeInfo(optional): object RouteInfo
  Title: RouteInfo
• routeProfId(optional): string

{
    "type":"object",
    "properties":{
        "dnai":{
            "type":"string"
        },
        "routeInfo":{
            "$ref":"#/definitions/RouteInfo"
        },
        "routeProfId":{
            "type":"string"
        }
    },
    "title":"RouteToLocs"
}

Nested Schema : RouteInfo

Type: object

Title: RouteInfo

Show Source

• ipv4Addr(optional): string
• ipv6Addr(optional): string
• portNumber(optional): integer(int32)
  Enter a number greater than or equal to 0

{
    "type":"object",
    "properties":{
        "ipv4Addr":{
            "type":"string"
        },
        "ipv6Addr":{
            "type":"string"
        },
        "portNumber":{
            "type":"integer",
            "format":"int32",
            "description":"Enter a number greater than or equal to 0"
        }
    },
    "title":"RouteInfo"
}

400 Response

Bad request

401 Response

Unauthorized

403 Response

Forbidden

404 Response

Not Found

429 Response

Too Many Requests

500 Response

Internal Server Error

503 Response

Service Unavailable

Back to Top