Jump to

• Request
• Response

Import Data Sources

post

ss/oc-cnpolicy-configuration/v1/datasources/import

Request

Supported Media Types

• application/json

Query Parameters

• action(optional): string
  Action

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

Body ()

body

Root Schema : DataSourcesIEDataReq

Type: object

Title: DataSourcesIEDataReq

Show Source

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

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

Nested Schema : exportData

Type: array

Show Source

• Array of: object DataSources
  Title: DataSources

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

Nested Schema : DataSources

Type: object

Title: DataSources

Show Source

• admin_state(optional): boolean
• description(optional): string
• enable_subscription(optional): boolean
• name: string
• primary_server(optional): object PrimaryServer
  Title: PrimaryServer
• quaternary_server(optional): object CommonServer
  Title: CommonServer
• read_connection(optional): string
  Allowed Values: [ "1", "10", "2", "3", "4", "5", "6", "7", "8", "9" ]
• realm(optional): string
• role(optional): string
  Allowed Values: [ "On Demand", "Secondary", "primary" ]
• search_criteria(optional): object SearchCriteria
  Title: SearchCriteria
• search_filter(optional): object SearchFilter
  Title: SearchFilter
• secondary_server(optional): object CommonServer
  Title: CommonServer
• sh_profile(optional): string
  Allowed Values: [ "v1", "v2", "v3", "v4" ]
• tertiary_server(optional): object CommonServer
  Title: CommonServer
• timer_profile(optional): string
• type(optional): string
  Allowed Values: [ "LDAP", "Sh", "Sy" ]
• use_notif_eff(optional): boolean

{
    "type":"object",
    "required":[
        "name"
    ],
    "properties":{
        "admin_state":{
            "type":"boolean"
        },
        "description":{
            "type":"string"
        },
        "enable_subscription":{
            "type":"boolean"
        },
        "name":{
            "type":"string"
        },
        "primary_server":{
            "$ref":"#/definitions/PrimaryServer"
        },
        "quaternary_server":{
            "$ref":"#/definitions/CommonServer"
        },
        "read_connection":{
            "type":"string",
            "enum":[
                "1",
                "10",
                "2",
                "3",
                "4",
                "5",
                "6",
                "7",
                "8",
                "9"
            ]
        },
        "realm":{
            "type":"string"
        },
        "role":{
            "type":"string",
            "enum":[
                "On Demand",
                "Secondary",
                "primary"
            ]
        },
        "search_criteria":{
            "$ref":"#/definitions/SearchCriteria"
        },
        "search_filter":{
            "$ref":"#/definitions/SearchFilter"
        },
        "secondary_server":{
            "$ref":"#/definitions/CommonServer"
        },
        "sh_profile":{
            "type":"string",
            "enum":[
                "v1",
                "v2",
                "v3",
                "v4"
            ]
        },
        "tertiary_server":{
            "$ref":"#/definitions/CommonServer"
        },
        "timer_profile":{
            "type":"string"
        },
        "type":{
            "type":"string",
            "enum":[
                "LDAP",
                "Sh",
                "Sy"
            ]
        },
        "use_notif_eff":{
            "type":"boolean"
        }
    },
    "title":"DataSources"
}

Nested Schema : PrimaryServer

Type: object

Title: PrimaryServer

Show Source

• addr: string
• identity: string
• port: string
  enter a range in [0-65535] number

{
    "type":"object",
    "required":[
        "addr",
        "identity",
        "port"
    ],
    "properties":{
        "addr":{
            "type":"string"
        },
        "identity":{
            "type":"string"
        },
        "port":{
            "type":"string",
            "description":"enter a range in [0-65535] number"
        }
    },
    "title":"PrimaryServer"
}

Nested Schema : CommonServer

Type: object

Title: CommonServer

Show Source

• addr(optional): string
• identity(optional): string
• port: string
  enter a range in [0-65535] number

{
    "type":"object",
    "required":[
        "port"
    ],
    "properties":{
        "addr":{
            "type":"string"
        },
        "identity":{
            "type":"string"
        },
        "port":{
            "type":"string",
            "description":"enter a range in [0-65535] number"
        }
    },
    "title":"CommonServer"
}

Nested Schema : SearchCriteria

Type: object

Title: SearchCriteria

Show Source

• baseDN(optional): string
• key_replace_ptn(optional): string
• key_transform_ptn(optional): string
• rootDN(optional): string
• type(optional): string
  Allowed Values: [ "IMSI", "MSISDN", "NAI" ]

{
    "type":"object",
    "properties":{
        "baseDN":{
            "type":"string"
        },
        "key_replace_ptn":{
            "type":"string"
        },
        "key_transform_ptn":{
            "type":"string"
        },
        "rootDN":{
            "type":"string"
        },
        "type":{
            "type":"string",
            "enum":[
                "IMSI",
                "MSISDN",
                "NAI"
            ]
        }
    },
    "title":"SearchCriteria"
}

Nested Schema : SearchFilter

Type: object

Title: SearchFilter

Show Source

• apn_filters_expr(optional): array apn_filters_expr
• id_filters_expr(optional): array id_filters_expr
• id_filters_type(optional): string
  Allowed Values: [ "IMSI", "MSISDN", "NAI" ]

{
    "type":"object",
    "properties":{
        "apn_filters_expr":{
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "id_filters_expr":{
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "id_filters_type":{
            "type":"string",
            "enum":[
                "IMSI",
                "MSISDN",
                "NAI"
            ]
        }
    },
    "title":"SearchFilter"
}

Nested Schema : apn_filters_expr

Type: array

Show Source

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : id_filters_expr

Type: array

Show Source

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

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

Type: object

Title: DataSourcesIEDataRes

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/DataSources"
            }
        },
        "key":{
            "type":"string"
        },
        "sourceVersion":{
            "type":"string"
        },
        "topic":{
            "type":"string"
        }
    },
    "title":"DataSourcesIEDataRes"
}

Nested Schema : exportData

Type: array

Show Source

• Array of: object DataSources
  Title: DataSources

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

Nested Schema : DataSources

Type: object

Title: DataSources

Show Source

• admin_state(optional): boolean
• description(optional): string
• enable_subscription(optional): boolean
• name: string
• primary_server(optional): object PrimaryServer
  Title: PrimaryServer
• quaternary_server(optional): object CommonServer
  Title: CommonServer
• read_connection(optional): string
  Allowed Values: [ "1", "10", "2", "3", "4", "5", "6", "7", "8", "9" ]
• realm(optional): string
• role(optional): string
  Allowed Values: [ "On Demand", "Secondary", "primary" ]
• search_criteria(optional): object SearchCriteria
  Title: SearchCriteria
• search_filter(optional): object SearchFilter
  Title: SearchFilter
• secondary_server(optional): object CommonServer
  Title: CommonServer
• sh_profile(optional): string
  Allowed Values: [ "v1", "v2", "v3", "v4" ]
• tertiary_server(optional): object CommonServer
  Title: CommonServer
• timer_profile(optional): string
• type(optional): string
  Allowed Values: [ "LDAP", "Sh", "Sy" ]
• use_notif_eff(optional): boolean

{
    "type":"object",
    "required":[
        "name"
    ],
    "properties":{
        "admin_state":{
            "type":"boolean"
        },
        "description":{
            "type":"string"
        },
        "enable_subscription":{
            "type":"boolean"
        },
        "name":{
            "type":"string"
        },
        "primary_server":{
            "$ref":"#/definitions/PrimaryServer"
        },
        "quaternary_server":{
            "$ref":"#/definitions/CommonServer"
        },
        "read_connection":{
            "type":"string",
            "enum":[
                "1",
                "10",
                "2",
                "3",
                "4",
                "5",
                "6",
                "7",
                "8",
                "9"
            ]
        },
        "realm":{
            "type":"string"
        },
        "role":{
            "type":"string",
            "enum":[
                "On Demand",
                "Secondary",
                "primary"
            ]
        },
        "search_criteria":{
            "$ref":"#/definitions/SearchCriteria"
        },
        "search_filter":{
            "$ref":"#/definitions/SearchFilter"
        },
        "secondary_server":{
            "$ref":"#/definitions/CommonServer"
        },
        "sh_profile":{
            "type":"string",
            "enum":[
                "v1",
                "v2",
                "v3",
                "v4"
            ]
        },
        "tertiary_server":{
            "$ref":"#/definitions/CommonServer"
        },
        "timer_profile":{
            "type":"string"
        },
        "type":{
            "type":"string",
            "enum":[
                "LDAP",
                "Sh",
                "Sy"
            ]
        },
        "use_notif_eff":{
            "type":"boolean"
        }
    },
    "title":"DataSources"
}

Nested Schema : PrimaryServer

Type: object

Title: PrimaryServer

Show Source

• addr: string
• identity: string
• port: string
  enter a range in [0-65535] number

{
    "type":"object",
    "required":[
        "addr",
        "identity",
        "port"
    ],
    "properties":{
        "addr":{
            "type":"string"
        },
        "identity":{
            "type":"string"
        },
        "port":{
            "type":"string",
            "description":"enter a range in [0-65535] number"
        }
    },
    "title":"PrimaryServer"
}

Nested Schema : CommonServer

Type: object

Title: CommonServer

Show Source

• addr(optional): string
• identity(optional): string
• port: string
  enter a range in [0-65535] number

{
    "type":"object",
    "required":[
        "port"
    ],
    "properties":{
        "addr":{
            "type":"string"
        },
        "identity":{
            "type":"string"
        },
        "port":{
            "type":"string",
            "description":"enter a range in [0-65535] number"
        }
    },
    "title":"CommonServer"
}

Nested Schema : SearchCriteria

Type: object

Title: SearchCriteria

Show Source

• baseDN(optional): string
• key_replace_ptn(optional): string
• key_transform_ptn(optional): string
• rootDN(optional): string
• type(optional): string
  Allowed Values: [ "IMSI", "MSISDN", "NAI" ]

{
    "type":"object",
    "properties":{
        "baseDN":{
            "type":"string"
        },
        "key_replace_ptn":{
            "type":"string"
        },
        "key_transform_ptn":{
            "type":"string"
        },
        "rootDN":{
            "type":"string"
        },
        "type":{
            "type":"string",
            "enum":[
                "IMSI",
                "MSISDN",
                "NAI"
            ]
        }
    },
    "title":"SearchCriteria"
}

Nested Schema : SearchFilter

Type: object

Title: SearchFilter

Show Source

• apn_filters_expr(optional): array apn_filters_expr
• id_filters_expr(optional): array id_filters_expr
• id_filters_type(optional): string
  Allowed Values: [ "IMSI", "MSISDN", "NAI" ]

{
    "type":"object",
    "properties":{
        "apn_filters_expr":{
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "id_filters_expr":{
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "id_filters_type":{
            "type":"string",
            "enum":[
                "IMSI",
                "MSISDN",
                "NAI"
            ]
        }
    },
    "title":"SearchFilter"
}

Nested Schema : apn_filters_expr

Type: array

Show Source

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : id_filters_expr

Type: array

Show Source

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

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