Jump to

• Request
• Response

Export Session Management Service

get

ss/oc-cnpolicy-configuration/v1/services/pcfsm/export

Request

There are no request parameters for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

OK.

Body ()

Root Schema : SessionManagementServiceIEDataRes

Type: object

Title: SessionManagementServiceIEDataRes

Show Source

• date(optional): string
• errors(optional): array errors
• exportData: object SessionManagementServiceRes
  Title: SessionManagementServiceRes
• sourceVersion(optional): string
• topic: string

{
    "type":"object",
    "required":[
        "exportData",
        "topic"
    ],
    "properties":{
        "date":{
            "type":"string"
        },
        "errors":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/ImportExportErrorMessage"
            }
        },
        "exportData":{
            "$ref":"#/definitions/SessionManagementServiceRes"
        },
        "sourceVersion":{
            "type":"string"
        },
        "topic":{
            "type":"string"
        }
    },
    "title":"SessionManagementServiceIEDataRes"
}

Nested Schema : errors

Type: array

Show Source

• Array of: object ImportExportErrorMessage
  Title: ImportExportErrorMessage

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

Nested Schema : SessionManagementServiceRes

Type: object

Title: SessionManagementServiceRes

Show Source

• audit(optional): object AuditConfiguration
  Title: AuditConfiguration
• binding(optional): object BindingConfiguration
  Title: BindingConfiguration
• charging(optional): object ChargingConfiguration
  Title: ChargingConfiguration
• imsEmergencySession(optional): object IMSEmergencySessionConfiguration
  Title: IMSEmergencySessionConfiguration
• policy(optional): object Policy
  Title: Policy
• policyControlRequestTrigger(optional): object PolicyControlRequestTrigger
  Title: PolicyControlRequestTrigger
• qos(optional): object QOSConfiguration
  Title: QOSConfiguration
• rule(optional): object RuleConfigurationRes
  Title: RuleConfigurationRes
• system(optional): object SystemConfiguration
  Title: SystemConfiguration
• trafficControl(optional): object TrafficControlConfiguration
  Title: TrafficControlConfiguration
• user(optional): object UserConfiguration
  Title: UserConfiguration

{
    "type":"object",
    "properties":{
        "audit":{
            "$ref":"#/definitions/AuditConfiguration"
        },
        "binding":{
            "$ref":"#/definitions/BindingConfiguration"
        },
        "charging":{
            "$ref":"#/definitions/ChargingConfiguration"
        },
        "imsEmergencySession":{
            "$ref":"#/definitions/IMSEmergencySessionConfiguration"
        },
        "policy":{
            "$ref":"#/definitions/Policy"
        },
        "policyControlRequestTrigger":{
            "$ref":"#/definitions/PolicyControlRequestTrigger"
        },
        "qos":{
            "$ref":"#/definitions/QOSConfiguration"
        },
        "rule":{
            "$ref":"#/definitions/RuleConfigurationRes"
        },
        "system":{
            "$ref":"#/definitions/SystemConfiguration"
        },
        "trafficControl":{
            "$ref":"#/definitions/TrafficControlConfiguration"
        },
        "user":{
            "$ref":"#/definitions/UserConfiguration"
        }
    },
    "title":"SessionManagementServiceRes"
}

Nested Schema : ImportExportErrorMessage

Type: object

Title: ImportExportErrorMessage

Show Source

• message(optional): string
• name(optional): string

{
    "type":"object",
    "properties":{
        "message":{
            "type":"string"
        },
        "name":{
            "type":"string"
        }
    },
    "title":"ImportExportErrorMessage"
}

Nested Schema : AuditConfiguration

Type: object

Title: AuditConfiguration

Show Source

• enable(optional): boolean
• frequency: integer(int32)
  enter a range in minutes from [5-1440]

  Example: 300
• maxTtl: integer(int32)
  enter a range in minutes from [10-20160]

  Example: 2880
• notificationRate: integer(int32)
  enter a range in sec from [20-700]

  Example: 50
• ttl: integer(int32)
  enter a range in minutes from [5-10080]

  Example: 1440

{
    "type":"object",
    "required":[
        "frequency",
        "maxTtl",
        "notificationRate",
        "ttl"
    ],
    "properties":{
        "enable":{
            "type":"boolean"
        },
        "frequency":{
            "type":"integer",
            "format":"int32",
            "example":300,
            "description":"enter a range in minutes from [5-1440]"
        },
        "maxTtl":{
            "type":"integer",
            "format":"int32",
            "example":2880,
            "description":"enter a range in minutes from [10-20160]"
        },
        "notificationRate":{
            "type":"integer",
            "format":"int32",
            "example":50,
            "description":"enter a range in sec from [20-700]"
        },
        "ttl":{
            "type":"integer",
            "format":"int32",
            "example":1440,
            "description":"enter a range in minutes from [5-10080]"
        }
    },
    "title":"AuditConfiguration"
}

Nested Schema : BindingConfiguration

Type: object

Title: BindingConfiguration

Show Source

• abortOnBindingError(optional): boolean
• bindingOperationEnabled(optional): boolean
• bsfRetryProfile(optional): string
• useHttp2(optional): boolean
• useLocalConfiguredBsfAlways(optional): boolean
• useLocalConfiguredBsfWhenNotDiscovered(optional): boolean

{
    "type":"object",
    "properties":{
        "abortOnBindingError":{
            "type":"boolean"
        },
        "bindingOperationEnabled":{
            "type":"boolean"
        },
        "bsfRetryProfile":{
            "type":"string"
        },
        "useHttp2":{
            "type":"boolean"
        },
        "useLocalConfiguredBsfAlways":{
            "type":"boolean"
        },
        "useLocalConfiguredBsfWhenNotDiscovered":{
            "type":"boolean"
        }
    },
    "title":"BindingConfiguration"
}

Nested Schema : ChargingConfiguration

Type: object

Title: ChargingConfiguration

Show Source

• chgDataIdPrefix(optional): string
  Example: chgdata_
• offline(optional): boolean
• online(optional): boolean
• primaryChfAddress(optional): string
• secondaryChfAddress(optional): string

{
    "type":"object",
    "properties":{
        "chgDataIdPrefix":{
            "type":"string",
            "example":"chgdata_"
        },
        "offline":{
            "type":"boolean"
        },
        "online":{
            "type":"boolean"
        },
        "primaryChfAddress":{
            "type":"string"
        },
        "secondaryChfAddress":{
            "type":"string"
        }
    },
    "title":"ChargingConfiguration"
}

Nested Schema : IMSEmergencySessionConfiguration

Type: object

Title: IMSEmergencySessionConfiguration

Show Source

• arpPreemptCap: string
  Allowed Values: [ "MAY_PREEMPT", "NOT_PREEMPT" ]
• arpPreemptVuln: string
  Allowed Values: [ "NOT_PREEMPTABLE", "PREEMPTABLE" ]
• arpPriorityLevel(optional): integer(int32)
• emergencyDNNs(optional): array emergencyDNNs
  Any number of values are permitted for Emergency DNNs

{
    "type":"object",
    "required":[
        "arpPreemptCap",
        "arpPreemptVuln"
    ],
    "properties":{
        "arpPreemptCap":{
            "type":"string",
            "enum":[
                "MAY_PREEMPT",
                "NOT_PREEMPT"
            ]
        },
        "arpPreemptVuln":{
            "type":"string",
            "enum":[
                "NOT_PREEMPTABLE",
                "PREEMPTABLE"
            ]
        },
        "arpPriorityLevel":{
            "type":"integer",
            "format":"int32"
        },
        "emergencyDNNs":{
            "type":"array",
            "description":"Any number of values are permitted for Emergency DNNs",
            "items":{
                "type":"string"
            }
        }
    },
    "title":"IMSEmergencySessionConfiguration"
}

Nested Schema : Policy

Type: object

Title: Policy

Show Source

• evaluateEnabled(optional): boolean

{
    "type":"object",
    "properties":{
        "evaluateEnabled":{
            "type":"boolean"
        }
    },
    "title":"Policy"
}

Nested Schema : PolicyControlRequestTrigger

Type: object

Title: PolicyControlRequestTrigger

Show Source

• defaultPolicyControlRequestTriggers(optional): array defaultPolicyControlRequestTriggers

{
    "type":"object",
    "properties":{
        "defaultPolicyControlRequestTriggers":{
            "type":"array",
            "items":{
                "type":"string",
                "enum":[
                    "AC_TY_CH",
                    "AN_CH_COR",
                    "AN_INFO",
                    "APP_STA",
                    "APP_STO",
                    "CM_SES_FAIL",
                    "DEF_QOS_CH",
                    "NO_CREDIT",
                    "PLMN_CH",
                    "PRA_CH",
                    "PS_DA_OFF",
                    "QOS_NOTIF",
                    "RAT_TY_CH",
                    "REF_QOS_IND_CH",
                    "RES_MO_RE",
                    "RES_RELEASE",
                    "RE_TIMEOUT",
                    "SAREA_CH",
                    "SCNN_CH",
                    "SE_AMBR_CH",
                    "SUCC_RES_ALLO",
                    "UE_IP_CH",
                    "UE_MAC_CH",
                    "US_RE"
                ]
            }
        }
    },
    "title":"PolicyControlRequestTrigger"
}

Nested Schema : QOSConfiguration

Type: object

Title: QOSConfiguration

Show Source

• defaultQos5qi(optional): string
  Example: 9
• defaultQosArpPreemptCap(optional): string
  Allowed Values: [ "MAY_PREEMPT", "NOT_PREEMPT" ]

  Example: MAY_PREEMPT
• defaultQosArpPreemptVuln(optional): string
  Allowed Values: [ "NOT_PREEMPTABLE", "PREEMPTABLE" ]

  Example: NOT_PREEMPTABLE
• defaultQosArpPriorityLevel(optional): string
  Example: 1
• installDefQosIfNotRequested(optional): boolean
• qosDataIdPrefix(optional): string
  Example: qosdata_
• updateDefaultPcfRuleWithAuthDefQos(optional): boolean

{
    "type":"object",
    "properties":{
        "defaultQos5qi":{
            "type":"string",
            "example":9
        },
        "defaultQosArpPreemptCap":{
            "type":"string",
            "example":"MAY_PREEMPT",
            "enum":[
                "MAY_PREEMPT",
                "NOT_PREEMPT"
            ]
        },
        "defaultQosArpPreemptVuln":{
            "type":"string",
            "example":"NOT_PREEMPTABLE",
            "enum":[
                "NOT_PREEMPTABLE",
                "PREEMPTABLE"
            ]
        },
        "defaultQosArpPriorityLevel":{
            "type":"string",
            "example":1
        },
        "installDefQosIfNotRequested":{
            "type":"boolean"
        },
        "qosDataIdPrefix":{
            "type":"string",
            "example":"qosdata_"
        },
        "updateDefaultPcfRuleWithAuthDefQos":{
            "type":"boolean"
        }
    },
    "title":"QOSConfiguration"
}

Nested Schema : RuleConfigurationRes

Type: object

Title: RuleConfigurationRes

Show Source

• appRulePrecedenceMax(optional): string
  Example: 899
• appRulePrecedenceMin(optional): string
  Example: 400
• defaultPccRule5qi(optional): string
  Example: 9
• defaultPccRuleArpPreemptCap(optional): string
  Allowed Values: [ "MAY_PREEMPT", "NOT_PREEMPT" ]

  Example: NOT_PREEMPT
• defaultPccRuleArpPreemptVuln(optional): string
  Allowed Values: [ "NOT_PREEMPTABLE", "PREEMPTABLE" ]

  Example: PREEMPTABLE
• defaultPccRuleArpPriorityLevel(optional): string
  Example: 15
• defaultPccRulePrecedence(optional): string
  Example: 3000
• defaultPccRuleProfile(optional): string
• installDefaultPccRule(optional): string
  Allowed Values: [ "ALWAYS", "IF_NO_PROVISIONED_RULE", "IF_NO_RULE", "NEVER" ]
• ruleIdPrefix(optional): string
  Example: 0_
• setPacketFilterUsageToTrueForPreliminaryServiceInfo(optional): boolean
• switchFlowInToOutEnabled(optional): boolean

{
    "type":"object",
    "properties":{
        "appRulePrecedenceMax":{
            "type":"string",
            "example":899
        },
        "appRulePrecedenceMin":{
            "type":"string",
            "example":400
        },
        "defaultPccRule5qi":{
            "type":"string",
            "example":9
        },
        "defaultPccRuleArpPreemptCap":{
            "type":"string",
            "example":"NOT_PREEMPT",
            "enum":[
                "MAY_PREEMPT",
                "NOT_PREEMPT"
            ]
        },
        "defaultPccRuleArpPreemptVuln":{
            "type":"string",
            "example":"PREEMPTABLE",
            "enum":[
                "NOT_PREEMPTABLE",
                "PREEMPTABLE"
            ]
        },
        "defaultPccRuleArpPriorityLevel":{
            "type":"string",
            "example":15
        },
        "defaultPccRulePrecedence":{
            "type":"string",
            "example":3000
        },
        "defaultPccRuleProfile":{
            "type":"string"
        },
        "installDefaultPccRule":{
            "type":"string",
            "enum":[
                "ALWAYS",
                "IF_NO_PROVISIONED_RULE",
                "IF_NO_RULE",
                "NEVER"
            ]
        },
        "ruleIdPrefix":{
            "type":"string",
            "example":"0_"
        },
        "setPacketFilterUsageToTrueForPreliminaryServiceInfo":{
            "type":"boolean"
        },
        "switchFlowInToOutEnabled":{
            "type":"boolean"
        }
    },
    "title":"RuleConfigurationRes"
}

Nested Schema : SystemConfiguration

Type: object

Title: SystemConfiguration

Show Source

• apiRoot(optional): string
• componentTracingEnabled(optional): boolean
• enableCustomJson(optional): boolean
• loglevel(optional): string
  Allowed Values: [ "DEBUG", "ERROR", "INFO", "WARN" ]
• metricsEnabled(optional): boolean
• overrideSupportedFeatures(optional): array overrideSupportedFeatures
• pcf_diamidentity(optional): string
  Example: pcf-smservice
• pcf_diamrealm(optional): string
  Example: pcf-smservice.svc
• pcf_fqdn(optional): string
  Example: pcf-smservice.pcf
• process400as200(optional): boolean
• smfNotificationRetryProfile(optional): string
• smfTerminateUriSegment(optional): string
  Example: terminate
• smfUpdateUriSegment(optional): string
  Example: update
• snssai(optional): string
  Example: 0,000000

{
    "type":"object",
    "properties":{
        "apiRoot":{
            "type":"string"
        },
        "componentTracingEnabled":{
            "type":"boolean"
        },
        "enableCustomJson":{
            "type":"boolean"
        },
        "loglevel":{
            "type":"string",
            "enum":[
                "DEBUG",
                "ERROR",
                "INFO",
                "WARN"
            ]
        },
        "metricsEnabled":{
            "type":"boolean"
        },
        "overrideSupportedFeatures":{
            "type":"array",
            "items":{
                "type":"string",
                "enum":[
                    "3GPP-PS-Data-Off",
                    "ADC",
                    "NetLoc",
                    "PCSCF-Restoration-Enhancement",
                    "PRA",
                    "PolicyUpdateWhenUESuspends",
                    "ProvAFsignalFlow",
                    "RAN-NAS-Cause",
                    "RAN-Support-Info",
                    "ResShare",
                    "RuleVersioning",
                    "SponsoredConnectivity",
                    "TSC",
                    "UMC"
                ]
            }
        },
        "pcf_diamidentity":{
            "type":"string",
            "example":"pcf-smservice"
        },
        "pcf_diamrealm":{
            "type":"string",
            "example":"pcf-smservice.svc"
        },
        "pcf_fqdn":{
            "type":"string",
            "example":"pcf-smservice.pcf"
        },
        "process400as200":{
            "type":"boolean"
        },
        "smfNotificationRetryProfile":{
            "type":"string"
        },
        "smfTerminateUriSegment":{
            "type":"string",
            "example":"terminate"
        },
        "smfUpdateUriSegment":{
            "type":"string",
            "example":"update"
        },
        "snssai":{
            "type":"string",
            "example":"0,000000"
        }
    },
    "title":"SystemConfiguration"
}

Nested Schema : TrafficControlConfiguration

Type: object

Title: TrafficControlConfiguration

Show Source

• tcDataIdPrefix(optional): string
  Example: tcdata_

{
    "type":"object",
    "properties":{
        "tcDataIdPrefix":{
            "type":"string",
            "example":"tcdata_"
        }
    },
    "title":"TrafficControlConfiguration"
}

Nested Schema : UserConfiguration

Type: object

Title: UserConfiguration

Show Source

• disableSubscriberVariables(optional): boolean
• enableChfQueryAll(optional): boolean
• ignoreSubsNotificationCheck(optional): boolean
• includeDnnInUserQuery(optional): boolean
• includeSnssaiInUserQuery(optional): boolean
• queryUser(optional): boolean
• queryUserOnDelete(optional): boolean
• queryUserOnReauth(optional): boolean
• queryUserOnUpdate(optional): boolean
• subsToNotifyEnabled(optional): boolean
• validateUser(optional): boolean

{
    "type":"object",
    "properties":{
        "disableSubscriberVariables":{
            "type":"boolean"
        },
        "enableChfQueryAll":{
            "type":"boolean"
        },
        "ignoreSubsNotificationCheck":{
            "type":"boolean"
        },
        "includeDnnInUserQuery":{
            "type":"boolean"
        },
        "includeSnssaiInUserQuery":{
            "type":"boolean"
        },
        "queryUser":{
            "type":"boolean"
        },
        "queryUserOnDelete":{
            "type":"boolean"
        },
        "queryUserOnReauth":{
            "type":"boolean"
        },
        "queryUserOnUpdate":{
            "type":"boolean"
        },
        "subsToNotifyEnabled":{
            "type":"boolean"
        },
        "validateUser":{
            "type":"boolean"
        }
    },
    "title":"UserConfiguration"
}

Nested Schema : emergencyDNNs

Type: array

Any number of values are permitted for Emergency DNNs

Show Source

• Array of: string

{
    "type":"array",
    "description":"Any number of values are permitted for Emergency DNNs",
    "items":{
        "type":"string"
    }
}

Nested Schema : defaultPolicyControlRequestTriggers

Type: array

Show Source

• Array of: string
  Allowed Values: [ "AC_TY_CH", "AN_CH_COR", "AN_INFO", "APP_STA", "APP_STO", "CM_SES_FAIL", "DEF_QOS_CH", "NO_CREDIT", "PLMN_CH", "PRA_CH", "PS_DA_OFF", "QOS_NOTIF", "RAT_TY_CH", "REF_QOS_IND_CH", "RES_MO_RE", "RES_RELEASE", "RE_TIMEOUT", "SAREA_CH", "SCNN_CH", "SE_AMBR_CH", "SUCC_RES_ALLO", "UE_IP_CH", "UE_MAC_CH", "US_RE" ]

{
    "type":"array",
    "items":{
        "type":"string",
        "enum":[
            "AC_TY_CH",
            "AN_CH_COR",
            "AN_INFO",
            "APP_STA",
            "APP_STO",
            "CM_SES_FAIL",
            "DEF_QOS_CH",
            "NO_CREDIT",
            "PLMN_CH",
            "PRA_CH",
            "PS_DA_OFF",
            "QOS_NOTIF",
            "RAT_TY_CH",
            "REF_QOS_IND_CH",
            "RES_MO_RE",
            "RES_RELEASE",
            "RE_TIMEOUT",
            "SAREA_CH",
            "SCNN_CH",
            "SE_AMBR_CH",
            "SUCC_RES_ALLO",
            "UE_IP_CH",
            "UE_MAC_CH",
            "US_RE"
        ]
    }
}

Nested Schema : overrideSupportedFeatures

Type: array

Show Source

• Array of: string
  Allowed Values: [ "3GPP-PS-Data-Off", "ADC", "NetLoc", "PCSCF-Restoration-Enhancement", "PRA", "PolicyUpdateWhenUESuspends", "ProvAFsignalFlow", "RAN-NAS-Cause", "RAN-Support-Info", "ResShare", "RuleVersioning", "SponsoredConnectivity", "TSC", "UMC" ]

{
    "type":"array",
    "items":{
        "type":"string",
        "enum":[
            "3GPP-PS-Data-Off",
            "ADC",
            "NetLoc",
            "PCSCF-Restoration-Enhancement",
            "PRA",
            "PolicyUpdateWhenUESuspends",
            "ProvAFsignalFlow",
            "RAN-NAS-Cause",
            "RAN-Support-Info",
            "ResShare",
            "RuleVersioning",
            "SponsoredConnectivity",
            "TSC",
            "UMC"
        ]
    }
}

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