Jump to

• Request
• Response

Import Peer Nodes

post

ss/oc-cnpolicy-configuration/v1/diameter/peernodes/import

Request

Supported Media Types

• application/json

Query Parameters

• action(optional): string
  Action

  Allowed Values: [ "ignore", "replace" ]

Body ()

body

Root Schema : PeerNodeIEData

Type: object

Title: PeerNodeIEData

Show Source

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

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

Nested Schema : exportData

Type: array

Show Source

• Array of: object PeerNode
  Title: PeerNode

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

Nested Schema : PeerNode

Type: object

Title: PeerNode

Show Source

• diamName: string
• dtype: string
  Allowed Values: [ "af", "backend", "dra", "ocs", "pcf", "tdf", "udr" ]
• host(optional): string
  enter a FQDN, ipv4 or ipv6 address'.
• identity(optional): string
  Enter valid FQDN.
• initiateConnection: boolean
• port(optional): string
  Enter a range in [0-65535].

  Example: 3868
• realm(optional): string
  Enter valid FQDN.
• reconnectLimit(optional): string
  enter number of seconds.

  Example: 3

{
    "type":"object",
    "required":[
        "diamName",
        "dtype",
        "initiateConnection"
    ],
    "properties":{
        "diamName":{
            "type":"string"
        },
        "dtype":{
            "type":"string",
            "enum":[
                "af",
                "backend",
                "dra",
                "ocs",
                "pcf",
                "tdf",
                "udr"
            ]
        },
        "host":{
            "type":"string",
            "description":"enter a FQDN, ipv4 or ipv6 address'."
        },
        "identity":{
            "type":"string",
            "description":"Enter valid FQDN."
        },
        "initiateConnection":{
            "type":"boolean"
        },
        "port":{
            "type":"string",
            "example":3868,
            "description":"Enter a range in [0-65535]."
        },
        "realm":{
            "type":"string",
            "description":"Enter valid FQDN."
        },
        "reconnectLimit":{
            "type":"string",
            "example":3,
            "description":"enter number of seconds."
        }
    },
    "title":"PeerNode"
}

Back to Top

Response

Supported Media Types

• application/problem+json

200 Response

OK

Body ()

Root Schema : schema

Type: object

201 Response

Imported

Body ()

Root Schema : PeerNodeIEData

Type: object

Title: PeerNodeIEData

Show Source

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

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

Nested Schema : exportData

Type: array

Show Source

• Array of: object PeerNode
  Title: PeerNode

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

Nested Schema : PeerNode

Type: object

Title: PeerNode

Show Source

• diamName: string
• dtype: string
  Allowed Values: [ "af", "backend", "dra", "ocs", "pcf", "tdf", "udr" ]
• host(optional): string
  enter a FQDN, ipv4 or ipv6 address'.
• identity(optional): string
  Enter valid FQDN.
• initiateConnection: boolean
• port(optional): string
  Enter a range in [0-65535].

  Example: 3868
• realm(optional): string
  Enter valid FQDN.
• reconnectLimit(optional): string
  enter number of seconds.

  Example: 3

{
    "type":"object",
    "required":[
        "diamName",
        "dtype",
        "initiateConnection"
    ],
    "properties":{
        "diamName":{
            "type":"string"
        },
        "dtype":{
            "type":"string",
            "enum":[
                "af",
                "backend",
                "dra",
                "ocs",
                "pcf",
                "tdf",
                "udr"
            ]
        },
        "host":{
            "type":"string",
            "description":"enter a FQDN, ipv4 or ipv6 address'."
        },
        "identity":{
            "type":"string",
            "description":"Enter valid FQDN."
        },
        "initiateConnection":{
            "type":"boolean"
        },
        "port":{
            "type":"string",
            "example":3868,
            "description":"Enter a range in [0-65535]."
        },
        "realm":{
            "type":"string",
            "description":"Enter valid FQDN."
        },
        "reconnectLimit":{
            "type":"string",
            "example":3,
            "description":"enter number of seconds."
        }
    },
    "title":"PeerNode"
}

400 Response

Bad request

401 Response

Unauthorized

403 Response

Forbidden

404 Response

Not Found

405 Response

Method Not Allowed

406 Response

Not Acceptable

408 Response

Request Timeout

409 Response

Conflict

412 Response

Precondition Failed

500 Response

Internal Server Error

503 Response

Service Unavailable

504 Response

Gateway Timeout

Back to Top