Jump to

• Request
• Response

Export Custom AVP

get

ss/oc-cnpolicy-configuration/v1/policydata/common/customattributes/avp/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 : CustomAVPIEData

Type: object

Title: CustomAVPIEData

Show Source

• date(optional): string
• errors(optional): array errors
• exportData: array exportData
• key(optional): string
• sourceVersion(optional): string
• topic: string

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

Nested Schema : errors

Type: array

Show Source

• Array of: object ImportExportErrorMessage
  Title: ImportExportErrorMessage

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

Nested Schema : exportData

Type: array

Show Source

• Array of: object CustomAVP
  Title: CustomAVP

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

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 : CustomAVP

Type: object

Title: CustomAVP

Show Source

• avpCode(optional): string
• avpType(optional): string
  Allowed Values: [ "address", "enumerated", "float32", "float64", "grouped", "id", "int32", "int64", "ipFilterRule", "octetString", "time", "uint32", "uint64", "uri", "utf8String" ]
• description(optional): string
• mandatoryFlag(optional): boolean
• mayEncryptFlag(optional): boolean
• name: string
• protectFlag(optional): boolean
• rootAvp(optional): string
  Allowed Values: [ "ADC-Rule-Definition:10415", "ADC-Rule-Install:10415", "ADC-Rule-Remove:10415", "ADC-Rule-Report:10415", "AF-Correlation-Information:10415", "Acceptable-Service-Info:10415", "Access-Network-Charging-Identifier-Gx:10415", "Access-Network-Charging-Identifier:10415", "Access-Network-Physical-Access-ID:5535", "Allocation-Retention-Priority:10415", "Application-Detection-Information:10415", "CC-Money", "Charging-Information:10415", "Charging-Rule-Definition-3GPP2:5535", "Charging-Rule-Definition:10415", "Charging-Rule-Event-Cisco:9", "Charging-Rule-Event-Trigger-Cisco:9", "Charging-Rule-Install-3GPP2:5535", "Charging-Rule-Install:10415", "Charging-Rule-Remove:10415", "Charging-Rule-Report-3GPP2:5535", "Charging-Rule-Report:10415", "Codec-Data-Tmp:10415", "Codec-Data:10415", "Conditional-Policy-Information:10415", "Cost-Information", "Default-EPS-Bearer-QoS:10415", "E2E-Sequence", "Envelope:10415", "Event-Report-Indication:10415", "Explicit-Route-Record:21274", "Explicit-Route:21274", "Failed-AVP", "Final-Unit-Indication", "Flow-Description-Info:5535", "Flow-Description:10415", "Flow-Grouping:10415", "Flow-Info:5535", "Flow-Information:10415", "Forwarding-Reason:21274", "G-S-U-Pool-Reference", "GGSN-IPv6-Address-3GPP:10415", "Granted-QoS:5535", "Granted-Service-Unit", "Juniper-Discovery-Descriptor:2636", "Juniper-Provisioning-Descriptor:2636", "Key-Destination:21274", "Key-Set:21274", "LI-Indicator-Gx:12951", "LI-TargetMFAddr:12951", "MIP-Home-Agent-Host", "MIP6-Agent-Info", "Media-Component-Description:10415", "Media-Sub-Component:10415", "Multiple-Services-Credit-Control", "Offline-Charging:10415", "Override-Charging-Action-Parameters:9", "Override-Charging-Parameters:9", "Override-Control:9", "Override-Policy-Parameters:9", "Override-QoS-Information:9", "PCEF-Forwarding-Info:971", "PCEF-Info:971", "PRA-Install:10415", "PRA-Remove:10415", "PS-Furnish-Charging-Information:10415", "PS-Information:10415", "Packet-Filter-Information:10415", "Pending-Policy-Counter-Information:10415", "Policy-Counter-FUI:12951", "Policy-Counter-Status-Report:10415", "Presence-Reporting-Area-Information:10415", "QoS-Information-3GPP2:5535", "QoS-Information:10415", "QoS-Rule-Install:10415", "Qos-Rule-Definition:10415", "Qos-Rule-Remove:10415", "Qos-Rule-Report:10415", "Reachable-Peer:21274", "Redirect-Information:10415", "Redirect-Server", "Repository-Data-ID", "Requested-QoS:5535", "Requested-Service-Unit", "Routing-Filter:10415", "Routing-Rule-Definition:10415", "Routing-Rule-Install:10415", "Routing-Rule-Remove:10415", "Service-Information:10415", "Service-Parameter-Info", "Siemens-DL-SDP-Data:4329", "Siemens-UL-SDP-Data:4329", "Sponsored-Connectivity-Data:10415", "Subscription-Id", "Subscription-Id-3GPP:10415", "Subsession-Decision-Info:10415", "Subsession-Enforcement-Info:10415", "Supported-Features:10415", "TDF-Information:10415", "TFT-Packet-Filter-Information:10415", "TMO-Redirect-Server:29168", "TWAN-Identifier:10415", "Time-Quota-Mechanism:10415", "Trigger:10415", "Tunnel-Header-Filter:10415", "Unit-Value", "Usage-Monitoring-Control:21274", "Usage-Monitoring-Information:10415", "Used-Service-Unit", "User-CSG-Information:10415", "User-Equipment-Info", "User-Location-Info-3GPP:10415", "VZW-Access-Network-Physical-Access-ID:12951", "Vendor-Specific-Application-Id" ]
• vendorId: string
  Allowed Values: [ "10415", "21274", "255", "2636", "3076", "4874", "5263", "5535", "9" ]
• VendorSpecificFlag(optional): boolean
• vendorSpecificFlag(optional): boolean

{
    "type":"object",
    "required":[
        "name",
        "vendorId"
    ],
    "properties":{
        "VendorSpecificFlag":{
            "type":"boolean"
        },
        "avpCode":{
            "type":"string"
        },
        "avpType":{
            "type":"string",
            "enum":[
                "address",
                "enumerated",
                "float32",
                "float64",
                "grouped",
                "id",
                "int32",
                "int64",
                "ipFilterRule",
                "octetString",
                "time",
                "uint32",
                "uint64",
                "uri",
                "utf8String"
            ]
        },
        "description":{
            "type":"string"
        },
        "mandatoryFlag":{
            "type":"boolean"
        },
        "mayEncryptFlag":{
            "type":"boolean"
        },
        "name":{
            "type":"string"
        },
        "protectFlag":{
            "type":"boolean"
        },
        "rootAvp":{
            "type":"string",
            "enum":[
                "ADC-Rule-Definition:10415",
                "ADC-Rule-Install:10415",
                "ADC-Rule-Remove:10415",
                "ADC-Rule-Report:10415",
                "AF-Correlation-Information:10415",
                "Acceptable-Service-Info:10415",
                "Access-Network-Charging-Identifier-Gx:10415",
                "Access-Network-Charging-Identifier:10415",
                "Access-Network-Physical-Access-ID:5535",
                "Allocation-Retention-Priority:10415",
                "Application-Detection-Information:10415",
                "CC-Money",
                "Charging-Information:10415",
                "Charging-Rule-Definition-3GPP2:5535",
                "Charging-Rule-Definition:10415",
                "Charging-Rule-Event-Cisco:9",
                "Charging-Rule-Event-Trigger-Cisco:9",
                "Charging-Rule-Install-3GPP2:5535",
                "Charging-Rule-Install:10415",
                "Charging-Rule-Remove:10415",
                "Charging-Rule-Report-3GPP2:5535",
                "Charging-Rule-Report:10415",
                "Codec-Data-Tmp:10415",
                "Codec-Data:10415",
                "Conditional-Policy-Information:10415",
                "Cost-Information",
                "Default-EPS-Bearer-QoS:10415",
                "E2E-Sequence",
                "Envelope:10415",
                "Event-Report-Indication:10415",
                "Explicit-Route-Record:21274",
                "Explicit-Route:21274",
                "Failed-AVP",
                "Final-Unit-Indication",
                "Flow-Description-Info:5535",
                "Flow-Description:10415",
                "Flow-Grouping:10415",
                "Flow-Info:5535",
                "Flow-Information:10415",
                "Forwarding-Reason:21274",
                "G-S-U-Pool-Reference",
                "GGSN-IPv6-Address-3GPP:10415",
                "Granted-QoS:5535",
                "Granted-Service-Unit",
                "Juniper-Discovery-Descriptor:2636",
                "Juniper-Provisioning-Descriptor:2636",
                "Key-Destination:21274",
                "Key-Set:21274",
                "LI-Indicator-Gx:12951",
                "LI-TargetMFAddr:12951",
                "MIP-Home-Agent-Host",
                "MIP6-Agent-Info",
                "Media-Component-Description:10415",
                "Media-Sub-Component:10415",
                "Multiple-Services-Credit-Control",
                "Offline-Charging:10415",
                "Override-Charging-Action-Parameters:9",
                "Override-Charging-Parameters:9",
                "Override-Control:9",
                "Override-Policy-Parameters:9",
                "Override-QoS-Information:9",
                "PCEF-Forwarding-Info:971",
                "PCEF-Info:971",
                "PRA-Install:10415",
                "PRA-Remove:10415",
                "PS-Furnish-Charging-Information:10415",
                "PS-Information:10415",
                "Packet-Filter-Information:10415",
                "Pending-Policy-Counter-Information:10415",
                "Policy-Counter-FUI:12951",
                "Policy-Counter-Status-Report:10415",
                "Presence-Reporting-Area-Information:10415",
                "QoS-Information-3GPP2:5535",
                "QoS-Information:10415",
                "QoS-Rule-Install:10415",
                "Qos-Rule-Definition:10415",
                "Qos-Rule-Remove:10415",
                "Qos-Rule-Report:10415",
                "Reachable-Peer:21274",
                "Redirect-Information:10415",
                "Redirect-Server",
                "Repository-Data-ID",
                "Requested-QoS:5535",
                "Requested-Service-Unit",
                "Routing-Filter:10415",
                "Routing-Rule-Definition:10415",
                "Routing-Rule-Install:10415",
                "Routing-Rule-Remove:10415",
                "Service-Information:10415",
                "Service-Parameter-Info",
                "Siemens-DL-SDP-Data:4329",
                "Siemens-UL-SDP-Data:4329",
                "Sponsored-Connectivity-Data:10415",
                "Subscription-Id",
                "Subscription-Id-3GPP:10415",
                "Subsession-Decision-Info:10415",
                "Subsession-Enforcement-Info:10415",
                "Supported-Features:10415",
                "TDF-Information:10415",
                "TFT-Packet-Filter-Information:10415",
                "TMO-Redirect-Server:29168",
                "TWAN-Identifier:10415",
                "Time-Quota-Mechanism:10415",
                "Trigger:10415",
                "Tunnel-Header-Filter:10415",
                "Unit-Value",
                "Usage-Monitoring-Control:21274",
                "Usage-Monitoring-Information:10415",
                "Used-Service-Unit",
                "User-CSG-Information:10415",
                "User-Equipment-Info",
                "User-Location-Info-3GPP:10415",
                "VZW-Access-Network-Physical-Access-ID:12951",
                "Vendor-Specific-Application-Id"
            ]
        },
        "vendorId":{
            "type":"string",
            "enum":[
                "10415",
                "21274",
                "255",
                "2636",
                "3076",
                "4874",
                "5263",
                "5535",
                "9"
            ]
        },
        "vendorSpecificFlag":{
            "type":"boolean"
        }
    },
    "title":"CustomAVP"
}

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