Jump to

• Request
• Response

Import Data Model

post

ss/oc-cnpolicy-configuration/v1/policymgmt/policytests/datamodels/import

Request

Supported Media Types

• application/json

Query Parameters

• action(optional): string
  Action

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

Body ()

body

Root Schema : DataModelIEData

Type: object

Title: DataModelIEData

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

Nested Schema : exportData

Type: array

Show Source

• Array of: object DataModel
  Title: DataModel

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

Nested Schema : DataModel

Type: object

Title: DataModel

Show Source

• description(optional): string
• enumItems(optional): array enumItems
• fields(optional): array fields
• id: string
• labelName: string
• multiValue(optional): boolean
• name: string
• type: string
  Allowed Values: [ "enum", "object" ]

{
    "type":"object",
    "required":[
        "id",
        "labelName",
        "name",
        "type"
    ],
    "properties":{
        "description":{
            "type":"string"
        },
        "enumItems":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/EnumItemConfiguration"
            }
        },
        "fields":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/FieldConfiguration"
            }
        },
        "id":{
            "type":"string"
        },
        "labelName":{
            "type":"string"
        },
        "multiValue":{
            "type":"boolean"
        },
        "name":{
            "type":"string"
        },
        "type":{
            "type":"string",
            "enum":[
                "enum",
                "object"
            ]
        }
    },
    "title":"DataModel"
}

Nested Schema : enumItems

Type: array

Show Source

• Array of: object EnumItemConfiguration
  Title: EnumItemConfiguration

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

Nested Schema : fields

Type: array

Show Source

• Array of: object FieldConfiguration
  Title: FieldConfiguration

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

Nested Schema : EnumItemConfiguration

Type: object

Title: EnumItemConfiguration

Show Source

• name(optional): string
• value(optional): string

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string"
        },
        "value":{
            "type":"string"
        }
    },
    "title":"EnumItemConfiguration"
}

Nested Schema : FieldConfiguration

Type: object

Title: FieldConfiguration

Show Source

• description(optional): string
• itemType(optional): object ItemConfiguration
  Title: ItemConfiguration
• labelName: string
• name: string
• objectType(optional): string
• primitiveType(optional): string
• type(optional): string
  Allowed Values: [ "array", "object", "primitive" ]

{
    "type":"object",
    "required":[
        "labelName",
        "name"
    ],
    "properties":{
        "description":{
            "type":"string"
        },
        "itemType":{
            "$ref":"#/definitions/ItemConfiguration"
        },
        "labelName":{
            "type":"string"
        },
        "name":{
            "type":"string"
        },
        "objectType":{
            "type":"string"
        },
        "primitiveType":{
            "type":"string"
        },
        "type":{
            "type":"string",
            "enum":[
                "array",
                "object",
                "primitive"
            ]
        }
    },
    "title":"FieldConfiguration"
}

Nested Schema : ItemConfiguration

Type: object

Title: ItemConfiguration

Show Source

• objectType(optional): string
• primitiveType(optional): string
  Allowed Values: [ "boolean", "measurement", "number", "string" ]
• type(optional): string
  Allowed Values: [ "object", "primitive" ]

{
    "type":"object",
    "properties":{
        "objectType":{
            "type":"string"
        },
        "primitiveType":{
            "type":"string",
            "enum":[
                "boolean",
                "measurement",
                "number",
                "string"
            ]
        },
        "type":{
            "type":"string",
            "enum":[
                "object",
                "primitive"
            ]
        }
    },
    "title":"ItemConfiguration"
}

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

Type: object

Title: DataModelIEData

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

Nested Schema : exportData

Type: array

Show Source

• Array of: object DataModel
  Title: DataModel

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

Nested Schema : DataModel

Type: object

Title: DataModel

Show Source

• description(optional): string
• enumItems(optional): array enumItems
• fields(optional): array fields
• id: string
• labelName: string
• multiValue(optional): boolean
• name: string
• type: string
  Allowed Values: [ "enum", "object" ]

{
    "type":"object",
    "required":[
        "id",
        "labelName",
        "name",
        "type"
    ],
    "properties":{
        "description":{
            "type":"string"
        },
        "enumItems":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/EnumItemConfiguration"
            }
        },
        "fields":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/FieldConfiguration"
            }
        },
        "id":{
            "type":"string"
        },
        "labelName":{
            "type":"string"
        },
        "multiValue":{
            "type":"boolean"
        },
        "name":{
            "type":"string"
        },
        "type":{
            "type":"string",
            "enum":[
                "enum",
                "object"
            ]
        }
    },
    "title":"DataModel"
}

Nested Schema : enumItems

Type: array

Show Source

• Array of: object EnumItemConfiguration
  Title: EnumItemConfiguration

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

Nested Schema : fields

Type: array

Show Source

• Array of: object FieldConfiguration
  Title: FieldConfiguration

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

Nested Schema : EnumItemConfiguration

Type: object

Title: EnumItemConfiguration

Show Source

• name(optional): string
• value(optional): string

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string"
        },
        "value":{
            "type":"string"
        }
    },
    "title":"EnumItemConfiguration"
}

Nested Schema : FieldConfiguration

Type: object

Title: FieldConfiguration

Show Source

• description(optional): string
• itemType(optional): object ItemConfiguration
  Title: ItemConfiguration
• labelName: string
• name: string
• objectType(optional): string
• primitiveType(optional): string
• type(optional): string
  Allowed Values: [ "array", "object", "primitive" ]

{
    "type":"object",
    "required":[
        "labelName",
        "name"
    ],
    "properties":{
        "description":{
            "type":"string"
        },
        "itemType":{
            "$ref":"#/definitions/ItemConfiguration"
        },
        "labelName":{
            "type":"string"
        },
        "name":{
            "type":"string"
        },
        "objectType":{
            "type":"string"
        },
        "primitiveType":{
            "type":"string"
        },
        "type":{
            "type":"string",
            "enum":[
                "array",
                "object",
                "primitive"
            ]
        }
    },
    "title":"FieldConfiguration"
}

Nested Schema : ItemConfiguration

Type: object

Title: ItemConfiguration

Show Source

• objectType(optional): string
• primitiveType(optional): string
  Allowed Values: [ "boolean", "measurement", "number", "string" ]
• type(optional): string
  Allowed Values: [ "object", "primitive" ]

{
    "type":"object",
    "properties":{
        "objectType":{
            "type":"string"
        },
        "primitiveType":{
            "type":"string",
            "enum":[
                "boolean",
                "measurement",
                "number",
                "string"
            ]
        },
        "type":{
            "type":"string",
            "enum":[
                "object",
                "primitive"
            ]
        }
    },
    "title":"ItemConfiguration"
}

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