{
    "swagger":"2.0",
    "info":{
        "title":"REST API for Oracle BI Publisher",
        "description":"Use the Oracle BI Publisher REST API to programmatically run and manage reports.",
        "version":"2017.08.10",
        "x-summary":"Use the Oracle BI Publisher REST API to programmatically run and manage reports."
    },
    "schemes":[
        "http",
        "https"
    ],
    "basePath":"/services/rest",
    "securityDefinitions":{
        "basicAuth":{
            "type":"basic",
            "description":"HTTP Basic Authentication. Works over `HTTP` and `HTTPS`"
        }
    },
    "paths":{
        "/v1/reports":{
            "post":{
                "summary":"Create report",
                "description":"Creates a report in the Oracle BI Publisher catalog. You can set the path to the data model, and supply template files and translation (XLIFF) files to the report definition.\n",
                "consumes":[
                    "multipart/form-data"
                ],
                "parameters":[
                    {
                        "name":"ReportRequest",
                        "in":"formData",
                        "description":"Report metadata having \"Content-Type: application/json\". Check the examples section for JSON structure details.\n",
                        "required":true,
                        "schema":{
                            "$ref":"#/definitions/CreateReportRequest"
                        }
                    },
                    {
                        "name":"TemplateData",
                        "in":"formData",
                        "description":"Template file. \"Content-Type: application/octet-stream\"",
                        "required":false,
                        "type":"file"
                    },
                    {
                        "name":"XliffData",
                        "in":"formData",
                        "description":"Translation file (XLIFF). \"Content-Type: application/octet-stream\" ",
                        "required":false,
                        "type":"file"
                    }
                ],
                "responses":{
                    "201":{
                        "description":"Report successfully created."
                    },
                    "400":{
                        "description":"An error occurred while creating the report"
                    }
                },
                "schema":null,
                "type":"string",
                "tags":[
                    "Manage Reports"
                ],
                "x-internal-id":"v1-reports-post"
            }
        },
        "/v1/reports/{reportPath}":{
            "get":{
                "summary":"Get report definition.",
                "description":"Gets information about a report, such as the default template, output type, and a list of template IDs. With the list of template IDs, you can generate a report with a template other than the default template.\n",
                "produces":[
                    "application/json"
                ],
                "parameters":[
                    {
                        "name":"reportPath",
                        "in":"path",
                        "type":"string",
                        "description":"URL encoded report path. For example, if your report path is \"/Sample Lite/Published Reporting/Reports/Balance Letter\", then your encoded report path will be \"%2FSample%20Lite%2FPublished%20Reporting%2FReports%2FBalance%20Letter\".\n",
                        "required":true
                    }
                ],
                "responses":{
                    "200":{
                        "description":"Returns report definition.",
                        "schema":{
                            "$ref":"#/definitions/ReportDefinition"
                        }
                    }
                },
                "tags":[
                    "Manage Reports"
                ],
                "x-internal-id":"v1-reports-{reportPath}-get"
            },
            "put":{
                "summary":"Update report definition",
                "description":"Updates the attributes of the report definition file (.xdo), and writes the file back to the Oracle BI Publisher catalog.\n",
                "consumes":[
                    "application/json"
                ],
                "parameters":[
                    {
                        "name":"reportPath",
                        "in":"path",
                        "type":"string",
                        "description":"URL encoded report path. For example, if your report path is \"/Sample Lite/Published Reporting/Reports/Balance Letter\", then your encoded report path will be \"%2FSample%20Lite%2FPublished%20Reporting%2FReports%2FBalance%20Letter\".\n",
                        "required":true
                    },
                    {
                        "name":"ReportDefinition",
                        "in":"body",
                        "description":"Report definition",
                        "schema":{
                            "$ref":"#/definitions/ReportDefinition"
                        }
                    }
                ],
                "responses":{
                    "200":{
                        "description":"Report definition update is successful."
                    },
                    "400":{
                        "description":"An error occurred while updating the report definition.",
                        "schema":{
                            "type":"string"
                        }
                    }
                },
                "tags":[
                    "Manage Reports"
                ],
                "x-internal-id":"v1-reports-{reportPath}-put"
            }
        },
        "/v1/reports/{reportPath}/parameters":{
            "post":{
                "summary":"Get report parameters",
                "description":"Gets an array of report parameters and their default values. With the list of parameters, you can set parameter values before running or scheduling a report.",
                "produces":[
                    "application/json"
                ],
                "parameters":[
                    {
                        "name":"reportPath",
                        "in":"path",
                        "type":"string",
                        "description":"URL encoded report path. For example, if your report path is \"/Sample Lite/Published Reporting/Reports/Balance Letter\" then your encoded report path will be \"%2FSample%20Lite%2FPublished%20Reporting%2FReports%2FBalance%20Letter\".\n",
                        "required":true
                    },
                    {
                        "name":"body",
                        "in":"body",
                        "description":"Report request",
                        "required":false,
                        "schema":{
                            "$ref":"#/definitions/ReportRequest"
                        }
                    }
                ],
                "responses":{
                    "200":{
                        "description":"Returns report parameters.",
                        "schema":{
                            "$ref":"#/definitions/ParamNameValues"
                        }
                    }
                },
                "tags":[
                    "Manage Reports"
                ],
                "x-internal-id":"v1-reports-{reportPath}-parameters-post"
            }
        },
        "/v1/reports/{reportPath}/sampleData":{
            "get":{
                "summary":"Get report sample data",
                "description":"Gets the sample data file stored with the report data model.",
                "produces":[
                    "application/octet-stream"
                ],
                "parameters":[
                    {
                        "name":"reportPath",
                        "in":"path",
                        "type":"string",
                        "description":"URL encoded report path. For example, if your report path is \"/Sample Lite/Published Reporting/Reports/Balance Letter\" then your encoded report path will be \"%2FSample%20Lite%2FPublished%20Reporting%2FReports%2FBalance%20Letter\".\n",
                        "required":true
                    }
                ],
                "responses":{
                    "200":{
                        "description":"Returns the report sample data in binary format.",
                        "schema":{
                            "type":"string",
                            "format":"binary"
                        }
                    }
                },
                "tags":[
                    "Manage Reports"
                ],
                "x-internal-id":"v1-reports-{reportPath}-sampleData-get"
            }
        },
        "/v1/reports/{reportPath}/templates/{templateId}":{
            "get":{
                "summary":"Get report template",
                "description":"Retrieves a template from a report definition in the Oracle BI Publisher catalog.",
                "produces":[
                    "application/octet-stream"
                ],
                "parameters":[
                    {
                        "name":"reportPath",
                        "in":"path",
                        "type":"string",
                        "description":"URL encoded report path. For exmple, if your report path is \"/Sample Lite/Published Reporting/Reports/Balance Letter\" then your encoded report path will be \"%2FSample%20Lite%2FPublished%20Reporting%2FReports%2FBalance%20Letter\".\n",
                        "required":true
                    },
                    {
                        "name":"templateId",
                        "in":"path",
                        "type":"string",
                        "description":"The ID of the template (for example, Chart Layout).",
                        "required":true
                    },
                    {
                        "name":"locale",
                        "in":"query",
                        "type":"string",
                        "description":"The locale of the template to retrieve (for example, en_US).",
                        "required":false
                    }
                ],
                "responses":{
                    "200":{
                        "description":"Returns the report template file in binary format.",
                        "schema":{
                            "type":"string",
                            "format":"binary"
                        }
                    }
                },
                "tags":[
                    "Manage Reports"
                ],
                "x-internal-id":"v1-reports-{reportPath}-templates-{templateId}-get"
            },
            "delete":{
                "summary":"Delete template",
                "description":"Removes a template from a report definition in the Oracle BI Publisher catalog.",
                "parameters":[
                    {
                        "name":"reportPath",
                        "in":"path",
                        "type":"string",
                        "description":"URL encoded report path. For example, if your report path is \"/Sample Lite/Published Reporting/Reports/Balance Letter\" then your encoded report path will be \"%2FSample%20Lite%2FPublished%20Reporting%2FReports%2FBalance%20Letter\".\n",
                        "required":true
                    },
                    {
                        "name":"templateId",
                        "in":"path",
                        "type":"string",
                        "description":"The ID of the template (for example, Chart Layout).",
                        "required":true
                    }
                ],
                "responses":{
                    "200":{
                        "description":"Report template is deleted successfully."
                    },
                    "404":{
                        "description":"Report template deletion failed."
                    }
                },
                "tags":[
                    "Manage Reports"
                ],
                "x-internal-id":"v1-reports-{reportPath}-templates-{templateId}-delete"
            },
            "put":{
                "summary":"Update template",
                "description":"Updates a template for a specific report in the Oracle BI Publisher catalog.",
                "consumes":[
                    "application/octet-stream"
                ],
                "parameters":[
                    {
                        "name":"reportPath",
                        "in":"path",
                        "type":"string",
                        "description":"URL encoded report path. For example, if your report path is \"/Sample Lite/Published Reporting/Reports/Balance Letter\" then your encoded report path will be \"%2FSample%20Lite%2FPublished%20Reporting%2FReports%2FBalance%20Letter\".\n",
                        "required":true
                    },
                    {
                        "name":"templateId",
                        "in":"path",
                        "type":"string",
                        "description":"The ID of the template (for example, Chart Layout).",
                        "required":true
                    },
                    {
                        "name":"templateData",
                        "in":"body",
                        "description":"Template file",
                        "schema":{
                            "type":"string",
                            "format":"binary"
                        }
                    }
                ],
                "responses":{
                    "200":{
                        "description":"Report template update is successful."
                    },
                    "400":{
                        "description":"Report template update failed."
                    }
                },
                "tags":[
                    "Manage Reports"
                ],
                "x-internal-id":"v1-reports-{reportPath}-templates-{templateId}-put"
            },
            "post":{
                "summary":"Create template",
                "description":"Creates a template that can be applied to a report in the Oracle BI Publisher catalog.\n",
                "consumes":[
                    "application/octet-stream"
                ],
                "parameters":[
                    {
                        "name":"reportPath",
                        "in":"path",
                        "type":"string",
                        "description":"URL encoded report path. For example, if your report path is \"/Sample Lite/Published Reporting/Reports/Balance Letter\" then your encoded report path will be \"%2FSample%20Lite%2FPublished%20Reporting%2FReports%2FBalance%20Letter\".\n",
                        "required":true
                    },
                    {
                        "name":"templateId",
                        "in":"path",
                        "type":"string",
                        "description":"The ID of the template (for example, Chart Layout).",
                        "required":true
                    },
                    {
                        "name":"templateType",
                        "in":"query",
                        "type":"string",
                        "description":"Template type. For example, rtf,xml."
                    },
                    {
                        "name":"locale",
                        "in":"query",
                        "type":"string",
                        "description":"The locale to assign to the template (for example, en_US)."
                    },
                    {
                        "name":"templateData",
                        "in":"body",
                        "description":"Template file",
                        "schema":{
                            "type":"string",
                            "format":"binary"
                        }
                    }
                ],
                "responses":{
                    "201":{
                        "description":"Report template is created successfully."
                    },
                    "400":{
                        "description":"Report template creation failed."
                    }
                },
                "tags":[
                    "Manage Reports"
                ],
                "x-internal-id":"v1-reports-{reportPath}-templates-{templateId}-post"
            }
        },
        "/v1/reports/{reportPath}/templates/{templateId}/parameters":{
            "get":{
                "summary":"Get report template parameters",
                "description":"Retrieves a template from a report definition in the Oracle BI Publisher catalog.",
                "produces":[
                    "application/json"
                ],
                "parameters":[
                    {
                        "name":"reportPath",
                        "in":"path",
                        "type":"string",
                        "description":"URL encoded report path. For example, if your report path is \"/Sample Lite/Published Reporting/Reports/Balance Letter\" then your encoded report path will be \"%2FSample%20Lite%2FPublished%20Reporting%2FReports%2FBalance%20Letter\".\n",
                        "required":true
                    },
                    {
                        "name":"templateId",
                        "in":"path",
                        "type":"string",
                        "description":"The ID of the template (for example, Chart Layout).",
                        "required":true
                    }
                ],
                "responses":{
                    "200":{
                        "description":"Returns report template parameters.",
                        "schema":{
                            "type":"array",
                            "items":{
                                "$ref":"#/definitions/ParamNameValue"
                            }
                        }
                    }
                },
                "tags":[
                    "Manage Reports"
                ],
                "x-internal-id":"v1-reports-{reportPath}-templates-{templateId}-parameters-get"
            }
        },
        "/v1/reports/{reportPath}/xdoSchema":{
            "get":{
                "summary":"Get XDO schema",
                "description":"Retrieves the XDO schema for a report definition in the Oracle BI Publisher catalog.",
                "produces":[
                    "application/octet-stream"
                ],
                "parameters":[
                    {
                        "name":"reportPath",
                        "in":"path",
                        "type":"string",
                        "description":"URL encoded report path. For example, if your report path is \"/Sample Lite/Published Reporting/Reports/Balance Letter\" then your encoded report path will be \"%2FSample%20Lite%2FPublished%20Reporting%2FReports%2FBalance%20Letter\".\n",
                        "required":true
                    }
                ],
                "responses":{
                    "200":{
                        "description":"Returns the xdo schema in binary format.",
                        "schema":{
                            "type":"array",
                            "items":{
                                "type":"string",
                                "format":"binary"
                            }
                        }
                    }
                },
                "tags":[
                    "Manage Reports"
                ],
                "x-internal-id":"v1-reports-{reportPath}-xdoSchema-get"
            }
        },
        "/v1/reports/{reportPath}/run":{
            "post":{
                "summary":"Run report",
                "description":"Sends a request to the Oracle BI Publisher server to run a specific report. \nThe request is syncronized, and the response contains the report output.\n",
                "consumes":[
                    "multipart/form-data"
                ],
                "produces":[
                    "multipart/form-data"
                ],
                "parameters":[
                    {
                        "name":"reportPath",
                        "in":"path",
                        "type":"string",
                        "description":"URL encoded report path. For example, if your report path is \"/Sample Lite/Published Reporting/Reports/Balance Letter\" then your encoded report path will be \"%2FSample%20Lite%2FPublished%20Reporting%2FReports%2FBalance%20Letter\".\n",
                        "required":true
                    },
                    {
                        "name":"ReportRequest",
                        "in":"formData",
                        "description":"Report request. \"Content-Type: application/json\". Check the ReportRequest of Get report parameters (/services/rest/v1/reports/{reportPath}/parameters) for JSON structure.",
                        "required":true,
                        "schema":{
                            "$ref":"#/definitions/ReportRequest"
                        }
                    },
                    {
                        "name":"ReportData",
                        "in":"formData",
                        "description":"Report data. \"Content-Type: application/octet-stream\"",
                        "type":"file",
                        "required":false
                    }
                ],
                "responses":{
                    "200":{
                        "description":"Returns the report output as multipart/form-data having two parts.\n\n1) ReportResponse having \"Content-Type: application/json\".\n\n2) ReportOutput having \"Content-Type: application/octet-stream\".\n",
                        "schema":{
                            "$ref":"#/definitions/ReportResponse"
                        }
                    }
                },
                "tags":[
                    "Manage Reports"
                ],
                "x-internal-id":"v1-reports-{reportPath}-run-post"
            }
        },
        "/v1/reports/{reportPath}/templateFiles/{templateFileName}/xliffs/{locale}":{
            "put":{
                "summary":"Update translation file (XLIFF)",
                "description":"Updates a translation file (XLIFF) associated with a layout definition in the \nOracle BI Publisher catalog.\n",
                "consumes":[
                    "application/octet-stream"
                ],
                "parameters":[
                    {
                        "name":"reportPath",
                        "in":"path",
                        "type":"string",
                        "description":"URL encoded report path. For example, if your report path is \"/Sample Lite/Published Reporting/Reports/Balance Letter\" then your encoded report path will be \"%2FSample%20Lite%2FPublished%20Reporting%2FReports%2FBalance%20Letter\".\n",
                        "required":true
                    },
                    {
                        "name":"templateFileName",
                        "in":"path",
                        "type":"string",
                        "description":"The file name of the layout to which to associate the XLIFF file. For example, employee_listing.rtf.",
                        "required":true
                    },
                    {
                        "name":"locale",
                        "in":"path",
                        "type":"string",
                        "description":"The locale to assign to the XLIFF (for example, en_US).",
                        "required":true
                    },
                    {
                        "name":"xliffData",
                        "in":"body",
                        "description":"Translation (XLIFF) file",
                        "required":true,
                        "schema":{
                            "type":"string",
                            "format":"binary"
                        }
                    }
                ],
                "responses":{
                    "200":{
                        "description":"Translation file for the specific template in report is updated successfully."
                    }
                },
                "tags":[
                    "Manage Reports"
                ],
                "x-internal-id":"v1-reports-{reportPath}-templateFiles-{templateFileName}-xliffs-{locale}-put"
            },
            "post":{
                "summary":"Create translation file (XLIFF)",
                "description":"Creates the translation file.",
                "consumes":[
                    "application/octet-stream"
                ],
                "parameters":[
                    {
                        "name":"reportPath",
                        "in":"path",
                        "type":"string",
                        "description":"Encoded report path",
                        "required":true
                    },
                    {
                        "name":"templateFileName",
                        "in":"path",
                        "type":"string",
                        "description":"Report request",
                        "required":true
                    },
                    {
                        "name":"locale",
                        "in":"path",
                        "type":"string",
                        "description":"The locale to assign to the XLIFF (for example, en_US).",
                        "required":true
                    },
                    {
                        "name":"xliffData",
                        "in":"body",
                        "description":"Attach translation (XLIFF) file",
                        "required":true,
                        "schema":{
                            "format":"binary"
                        }
                    }
                ],
                "responses":{
                    "201":{
                        "description":"When create is successful."
                    },
                    "400":{
                        "description":"In case of issues."
                    }
                },
                "tags":[
                    "Manage Reports"
                ],
                "x-internal-id":"v1-reports-{reportPath}-templateFiles-{templateFileName}-xliffs-{locale}-post"
            }
        }
    },
    "definitions":{
        "ReportResponse":{
            "type":"object",
            "properties":{
                "ReportResponse":{
                    "description":"\"Content-Type: application/json\"",
                    "$ref":"#/definitions/ReportResponseMetaData"
                },
                "ReportOutput":{
                    "type":"string",
                    "format":"binary",
                    "description":"Report output."
                }
            }
        },
        "ReportResponseMetaData":{
            "type":"object",
            "properties":{
                "metaDataList":{
                    "$ref":"#/definitions/MetaDataList"
                },
                "reportContentType":{
                    "type":"string",
                    "description":"The report content type. Possible values include:\n\"text/html;charset=UTF-8\"\"text/plain;charset=UTF-8\"\n \"application/pdf\"\n \"application/vnd.ms-powerpoint\"\n \"application/vnd.ms-excel\"\n \"application/msword\"\n \"application/x-shockwave-flash\"\n \"text/xml\" \"message/rfc822\"\n"
                },
                "reportLocale":{
                    "type":"string",
                    "description":"The locale selected for the report (for example, fr_FR)."
                }
            }
        },
        "MetaDataList":{
            "type":"object",
            "properties":{
                "metaDataName":{
                    "type":"string",
                    "description":"The name of the metadata."
                },
                "metaDataValue":{
                    "type":"string",
                    "description":"The metadata content."
                }
            }
        },
        "CreateReportRequest":{
            "type":"object",
            "properties":{
                "name":{
                    "type":"string",
                    "description":"Name of the report. Do not suffix the report name with .xdo."
                },
                "absolutePath":{
                    "type":"string",
                    "description":"The path to the folder in which to place the created report. For example, xmlp/Reports/financials."
                },
                "dataModelPath":{
                    "type":"string",
                    "description":"The path to the data model that will be used as the data source for this report. For example, xmlp/Reports/financials/Data Models/my data model.xdm."
                },
                "templateFileName":{
                    "type":"string",
                    "description":"The file name of the template to add the report definition."
                },
                "xliffFileName":{
                    "type":"string",
                    "description":"The file name of the XLIFF file."
                },
                "update":{
                    "type":"boolean",
                    "description":"If true, overwrites the existing report. If false, throws error if the report exists."
                }
            }
        },
        "ReportRequest":{
            "type":"object",
            "properties":{
                "parameterNameValues":{
                    "$ref":"#/definitions/ParamNameValues"
                },
                "byPassCache":{
                    "type":"boolean",
                    "default":false,
                    "description":"True indicates to bypass document cache."
                },
                "xdopropertyList":{
                    "$ref":"#/definitions/MetaDataList"
                },
                "attributeFormat":{
                    "description":"The output format of the requested report.",
                    "type":"string"
                },
                "attributeLocale":{
                    "description":"The locale selection for the report. Example: fr-FR",
                    "type":"string"
                },
                "attributeTemplate":{
                    "description":"The template to apply to the report. For example, Employeelisting.rtf.",
                    "type":"string"
                },
                "attributeTimezone":{
                    "description":"Specifies the time zone to use for the request, using a supported Java time zone ID. For example, \"America/Los_Angeles\".",
                    "type":"string"
                },
                "attributeCalendar":{
                    "description":"The formatting calendar to use for the report request. Valid values are: \"Gregorian\", \"Arabic Hijrah\", \"English Hijrah\", \"Japanese Imperial\", \"Thai Buddha\", and \"ROC Official\".",
                    "type":"string"
                },
                "attributeUILocale":{
                    "description":"The locale selection for the report. Example: fr-FR",
                    "type":"string"
                },
                "dynamicDataSource":{
                    "description":"If the data source for the report is not defined, you can dynamically define it.",
                    "$ref":"#/definitions/BIPDataSource"
                },
                "flattenXML":{
                    "description":"True indicates that the XML is to be flattened. This flag is used for the Analyzer for Microsoft Excel because Excel requires XML data type to be flattened.",
                    "type":"boolean",
                    "default":false
                }
            }
        },
        "ReportDefinition":{
            "type":"object",
            "properties":{
                "ESSJobName":{
                    "type":"string",
                    "description":"ESS job name."
                },
                "autoRun":{
                    "type":"boolean",
                    "description":"True indicates that the report property Auto Run is turned on."
                },
                "cacheDocument":{
                    "type":"boolean",
                    "description":"True indicates that the report property Enable document cache is turned on."
                },
                "controledByExtApp":{
                    "type":"boolean",
                    "description":"Whether the report definition is controlled by an external application (true) or not (false)."
                },
                "dataModelURL":{
                    "type":"string",
                    "description":"The .xdm location from where to get the Data Model definition."
                },
                "defaultOutputFormat":{
                    "type":"string",
                    "description":"The default output format. Valid values include:\ncsv (CSV)\ndata (Data)\neText (eText template)\nexcel (Microsoft Excel)\nexcel2000 (Microsoft Excel 2000)\nflash (Adobe Flash)\nhtml (HTML)\nmhtml (MIME HTML)\npdf (Adobe PDF)\nppt (Microsoft PowerPoint)\nrtf (Rich Text Format)\n"
                },
                "defaultTemplateId":{
                    "type":"string",
                    "description":"The default template identified for the report."
                },
                "diagnostics":{
                    "type":"boolean",
                    "description":"True indicates that diagnostics have been turned on for the report."
                },
                "listOfTemplateFormatsLabelValues":{
                    "type":"array",
                    "items":{
                        "$ref":"#/definitions/TemplateFormatsLabelValues"
                    }
                },
                "onLine":{
                    "type":"boolean",
                    "description":"True indicates the property \"Run report online\" is turned on for the report."
                },
                "openLinkInNewWindow":{
                    "type":"boolean",
                    "description":"True indicates the property \"Open Links in New Window\" is turned on for the report."
                },
                "parameterColumns":{
                    "type":"integer",
                    "description":"The value of the report property \"Parameters per line.\""
                },
                "reportDefnTitle":{
                    "type":"string",
                    "description":"Inactive. Do not use."
                },
                "reportDescription":{
                    "type":"string",
                    "description":"The user-assigned description of the report."
                },
                "reportName":{
                    "type":"string",
                    "description":"The user-assigned name for the report."
                },
                "reportParameterNameValues":{
                    "type":"array",
                    "items":{
                        "$ref":"#/definitions/ParamNameValues"
                    }
                },
                "reportType":{
                    "type":"string",
                    "description":"Inactive. Do not use."
                },
                "showControls":{
                    "type":"boolean",
                    "description":"True indicates the report property \"Show controls\" has been turned on."
                },
                "showReportLinks":{
                    "type":"boolean",
                    "description":"True indicates the report property \"Show report links\" has been turned on."
                },
                "templateIds":{
                    "type":"array",
                    "description":"Passes the layout names of the report templates.",
                    "items":{
                        "type":"string"
                    }
                }
            }
        },
        "TemplateFormatsLabelValues":{
            "type":"object",
            "properties":{
                "active":{
                    "type":"boolean",
                    "description":"Whether the template is active (true) or not (false)."
                },
                "applyStyleTemplate":{
                    "type":"boolean",
                    "description":"Whether to apply the style template (true) or not (false)."
                },
                "default":{
                    "type":"boolean",
                    "description":"Whether the template is the default template (true) or not (false)."
                },
                "listOfTemplateFormatLabelValue":{
                    "type":"array",
                    "description":"Contains the TemplateFormatLabelValue label-value pairs .",
                    "items":{
                        "$ref":"#/definitions/TemplateFormatLabelValue"
                    }
                },
                "templateAvailableLocales":{
                    "type":"array",
                    "description":"The available locale options defined for a template",
                    "items":{
                        "type":"string"
                    }
                },
                "templateBaseLocale":{
                    "type":"string",
                    "description":"The base locale options defined for a template."
                },
                "templateDefaultLocale":{
                    "type":"string",
                    "description":"The default locale options defined for a template."
                },
                "templateID":{
                    "type":"string",
                    "description":"The name assigned to the template in Oracle BI Publisher, for example: \"Employee Listing\".\n"
                },
                "templateType":{
                    "type":"string",
                    "description":"The type of template, for example: \"rtf\" or \"pdf\"."
                },
                "templateURL":{
                    "type":"string",
                    "description":"The template file name in the Oracle BI Publisher repository, for example: \"Employee Listing.rtf\"."
                },
                "viewOnline":{
                    "type":"boolean",
                    "description":"Whether the template can be viewed online (true) or not (false)."
                }
            }
        },
        "TemplateFormatLabelValue":{
            "type":"object",
            "properties":{
                "templateFormatLabel":{
                    "type":"string",
                    "description":"The label that displays for a template format. For Example, \"HTML\", \"PDF\", \"Excel\". "
                },
                "templateFormatValue":{
                    "type":"string",
                    "description":"The template format value that corresponds to the label. Examples include: \"html\" \"pdf\" \"excel\"."
                }
            }
        },
        "ParamNameValues":{
            "type":"object",
            "properties":{
                "listOfParamNameValues":{
                    "type":"array",
                    "description":"An array of ParamNameValue",
                    "items":{
                        "$ref":"#/definitions/ParamNameValue"
                    }
                }
            }
        },
        "ParamNameValue":{
            "type":"object",
            "properties":{
                "UIType":{
                    "type":"string",
                    "description":"The type of parameter as defined in the Oracle BI Publisher data model user interface.\nValid values include:\nDate\nHidden\nMenu\nSearch\nText\n"
                },
                "dataType":{
                    "type":"string",
                    "description":"Valid values include:\nBoolean\nDate\nFloat\nInteger\nString\n"
                },
                "dateFormatString":{
                    "type":"string",
                    "description":"If UIType is \"Date\", this specifies the Date Format String. The date format string must be a Java date format (for example, MM-DD-YYYY)."
                },
                "dateFrom":{
                    "type":"string",
                    "description":"If UIType is \"Date\", this specifies the begin value of the date."
                },
                "dateTo":{
                    "type":"string",
                    "description":"If UIType is \"Date\", this specifies the end value of the date."
                },
                "defaultValue":{
                    "type":"string",
                    "description":"Specifies the default value of the parameter."
                },
                "fieldSize":{
                    "type":"string",
                    "description":"For parameter types \"Text\" and \"Date\", specifies the text field size for the parameter."
                },
                "label":{
                    "type":"string",
                    "description":"For all parameter types except \"Hidden\", specifies the display label for the parameter."
                },
                "lovLabels":{
                    "type":"array",
                    "description":"If the parameter type is \"Menu\", specifies the values displayed in the list of values to the user.",
                    "items":{
                        "type":"string"
                    }
                },
                "multiValuesAllowed":{
                    "type":"boolean",
                    "description":"True indicates that a parameter may contain multiple values."
                },
                "name":{
                    "type":"string",
                    "description":"The parameter name."
                },
                "refreshParamOnChange":{
                    "type":"boolean",
                    "description":"For parameter types \"Text\" and \"Menu\", a value of true for this parameter indicates that other defined parameters should be refreshed when a selection is made for this parameter.\n"
                },
                "selectAll":{
                    "type":"boolean",
                    "description":"For parameter type \"Menu\", a value of true indicates that all values can be selected for the LOV."
                },
                "templateParam":{
                    "type":"boolean",
                    "description":"A value of true indicates the parameter is defined in the RTF template."
                },
                "useNullForAll":{
                    "type":"boolean",
                    "description":"For parameter type \"Menu\", a value of true indicates that a null will be passed if all values are selected for the parameter."
                },
                "values":{
                    "type":"array",
                    "description":"Parameter values.",
                    "items":{
                        "type":"string"
                    }
                }
            }
        },
        "BIPDataSource":{
            "type":"object",
            "properties":{
                "fileDataSource":{
                    "$ref":"#/definitions/FileDataSource"
                },
                "jdbcdataSource":{
                    "$ref":"#/definitions/JDBCDataSource"
                }
            }
        },
        "FileDataSource":{
            "type":"object",
            "properties":{
                "dynamicDataSourcePath":{
                    "description":"To specify a path to a data source that resides on an available server, specify the full path to the data source and set temporaryDataSource to \"false\". For example: \"D:\\BI\\OracleBI\\xmlp\\XMLP\\DemoFiles\\Balance.xml\")\"\nIf the file is located in the system temporary directory, set temporaryDataSource to true, and specify the file name here. For example: \"Balance.xml\".\n",
                    "type":"string"
                },
                "temporaryDataSource":{
                    "description":"Set to \"true\" when the file data source is in the system temporary directory. Set to \"false\" when dynamicDataSourcePath specifies the full path.",
                    "type":"boolean",
                    "default":false
                }
            }
        },
        "JDBCDataSource":{
            "type":"object",
            "properties":{
                "dataSourceName":{
                    "description":"The Data Source Name assigned to the data source in the Oracle BI Publisher data source definition page (for example, Oracle).",
                    "type":"string"
                },
                "jdbcdriverClass":{
                    "description":"The JDBC driver class for the data source (for example, oracle.jdbc.OracleDriver).",
                    "type":"string"
                },
                "jdbcdriverType":{
                    "description":"The driver type as defined in the Oracle BI Publisher data source definition page (for example, Oracle10g/11g/12c).",
                    "type":"string"
                },
                "preProcessFunc":{
                    "description":"Enter a PL/SQL function to execute when a connection is created (Pre Process).",
                    "type":"string"
                },
                "postProcessFunc":{
                    "description":"Enter a PL/SQL function to execute when a connection is closed (Post Process).",
                    "type":"string"
                },
                "jdbcurl":{
                    "description":"The connection string for the data source (for example, jdbc:oracle:thin:@mydatabase.foobar.com.example:1521: orcl).",
                    "type":"string"
                },
                "jdbcuserName":{
                    "description":"The user name for the data source as defined in the Oracle BI Publisher data source definition page.",
                    "type":"string"
                },
                "jdbcpassword":{
                    "description":"The password for the data source as defined in the Oracle BI Publisher data source definition page.",
                    "type":"string"
                },
                "useProxyAuth":{
                    "description":"Enable Proxy Authentication.",
                    "type":"boolean",
                    "default":false
                }
            }
        }
    },
    "tags":[
        {
            "name":"Manage Reports",
            "description":"Manage Oracle BI Publisher Reports"
        }
    ]
}