Jump to

• Request
• Response

Import policy

post

ss/oc-cnpolicy-configuration/v1/policymgmt/policyprojects/policy/import

Request

Supported Media Types

• application/json

Query Parameters

• action(optional): string
  Action to perform on conflict

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

Body ()

body

Root Schema : PolicyProjectIEData

Type: object

Title: PolicyProjectIEData

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

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 PolicyProjectConfiguration
  Title: PolicyProjectConfiguration

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

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

Type: object

Title: PolicyProjectConfiguration

Show Source

• description(optional): string
• entrance(optional): boolean
• key(optional): string
• layout(optional): string
• name(optional): string
• outputModels(optional): array outputModels
• policy(optional): array policy
• projectId(optional): string
• script(optional): string
• serviceType(optional): string

{
    "type":"object",
    "properties":{
        "description":{
            "type":"string"
        },
        "entrance":{
            "type":"boolean"
        },
        "key":{
            "type":"string"
        },
        "layout":{
            "type":"string"
        },
        "name":{
            "type":"string"
        },
        "outputModels":{
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "policy":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/PolicyConfiguration"
            }
        },
        "projectId":{
            "type":"string"
        },
        "script":{
            "type":"string"
        },
        "serviceType":{
            "type":"string"
        }
    },
    "title":"PolicyProjectConfiguration"
}

Nested Schema : outputModels

Type: array

Show Source

• Array of: string

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

Nested Schema : policy

Type: array

Show Source

• Array of: object PolicyConfiguration
  Title: PolicyConfiguration

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

Nested Schema : PolicyConfiguration

Type: object

Title: PolicyConfiguration

Show Source

• entrance(optional): boolean
• layout(optional): string
• name(optional): string
• outputModels(optional): array outputModels
• script(optional): string

{
    "type":"object",
    "properties":{
        "entrance":{
            "type":"boolean"
        },
        "layout":{
            "type":"string"
        },
        "name":{
            "type":"string"
        },
        "outputModels":{
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "script":{
            "type":"string"
        }
    },
    "title":"PolicyConfiguration"
}

Nested Schema : outputModels

Type: array

Show Source

• Array of: string

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

Back to Top

Response

Supported Media Types

• application/json

200 Response

Policy imported

Body ()

Root Schema : PolicyProjectIEData

Type: object

Title: PolicyProjectIEData

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

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 PolicyProjectConfiguration
  Title: PolicyProjectConfiguration

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

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

Type: object

Title: PolicyProjectConfiguration

Show Source

• description(optional): string
• entrance(optional): boolean
• key(optional): string
• layout(optional): string
• name(optional): string
• outputModels(optional): array outputModels
• policy(optional): array policy
• projectId(optional): string
• script(optional): string
• serviceType(optional): string

{
    "type":"object",
    "properties":{
        "description":{
            "type":"string"
        },
        "entrance":{
            "type":"boolean"
        },
        "key":{
            "type":"string"
        },
        "layout":{
            "type":"string"
        },
        "name":{
            "type":"string"
        },
        "outputModels":{
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "policy":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/PolicyConfiguration"
            }
        },
        "projectId":{
            "type":"string"
        },
        "script":{
            "type":"string"
        },
        "serviceType":{
            "type":"string"
        }
    },
    "title":"PolicyProjectConfiguration"
}

Nested Schema : outputModels

Type: array

Show Source

• Array of: string

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

Nested Schema : policy

Type: array

Show Source

• Array of: object PolicyConfiguration
  Title: PolicyConfiguration

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

Nested Schema : PolicyConfiguration

Type: object

Title: PolicyConfiguration

Show Source

• entrance(optional): boolean
• layout(optional): string
• name(optional): string
• outputModels(optional): array outputModels
• script(optional): string

{
    "type":"object",
    "properties":{
        "entrance":{
            "type":"boolean"
        },
        "layout":{
            "type":"string"
        },
        "name":{
            "type":"string"
        },
        "outputModels":{
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "script":{
            "type":"string"
        }
    },
    "title":"PolicyConfiguration"
}

Nested Schema : outputModels

Type: array

Show Source

• Array of: string

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

201 Response

Created

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