REST API for Unified Assurance Core

Create a Report Profile

post

/api/report/Profiles

Creates a new report profile.
The minimum required properties in the request body are:

ReportProfileName
NotificationProfileID
Archive
ArchiveExpiryDays
Height
Width
AutoSize
Zoom
ReportFormat

Request

There are no request parameters for this operation.

Supported Media Types

application/json

Root Schema : schema

Match All

Show Source

object schema

{
    "allOf":[
        {
            "$ref":"#/components/schemas/reportProfiles"
        }
    ],
    "required":[
        "ReportProfileName",
        "NotificationProfileID",
        "Archive",
        "ArchiveExpiryDays",
        "Height",
        "Width",
        "AutoSize",
        "Zoom",
        "ReportFormat"
    ]
}

Nested Schema : schema

Type: object

Show Source

Archive: integer

Checkbox to indicate whether the report results will be archived in the file repository or not. Allowed Values: - 0 => Disabled - 1 => Enabled

Example: 1
ArchiveExpireDays: integer

Number of days to keep archived reports before they expire. It is Required when Archive is 1.

Example: 30
Autosize: integer

Flag indicating whether the report runner should calculate width and height for the image or pdf Allowed Values: - 0 => Use user defined configuration - 1 => Autosize

Example: 1
DataFormat: string

If Report Format is set to "Data Export", the type of file that is generated. Allowed Values: - Excel 2007+(*.xlsx) - Excel 97-2003(*.xls) - CSV - Hypertext(*.html) - PDF

Example: Excel 2007+(*.xlsx)
Height: integer

Height of the output in pixels

Example: 1800
ManualPageSize: string

If Page Size is set to "Manual", a string explaining the page size to use in the PDF. Examples are "5in*7.5in", "10cm*20cm", "A4", "Letter".

Example: Letter
NotificationProfileID: integer

The profile ID used to notify the recipients that the scheduled report is ready.

Example: 1
NotificationTemplateID: integer

The template ID used to notify the recipients that the scheduled report is ready.

Example: 3
Orientation: string

Page orientation used by PDF Allowed Values: - Landscape - Portrait

Example: Landscape
PageSize: string

If Report Format is set to "PDF", the page size for the PDF to use. Allowed Values: - A4 - Letter - Manual

Example: Letter
ReportFormat: string

The type of output the report will produce. Allowed Values: - PNG - PDF - Data Export

Example: PDF
ReportProfileName: string

The report profile name.
To avoid confusion with numeric IDs, the name value cannot be integers only or integers prefixed with the + or - symbols only. It must contain letters or other characters. For example, 1234, +1234, and -1234 are not valid, but US1234, US+1234 and US_1234 are.

Example: Generic Email
Width: integer

Width of the output in pixels

Example: 1024
Zoom: number

PDF Zoom level needed to scale content

Example: 1

{
    "properties":{
        "ReportProfileName":{
            "description":"The report profile name.\n<br>To avoid confusion with numeric IDs, the name value cannot be integers only or integers prefixed with the + or - symbols only. It must contain letters or other characters. For example, <b>1234</b>, <b>+1234</b>, and <b>-1234</b> are not valid, but <b>US1234</b>, <b>US+1234</b> and <b>US_1234</b> are.",
            "type":"string",
            "example":"Generic Email"
        },
        "NotificationProfileID":{
            "$ref":"#/components/schemas/reportProfilesRead/properties/NotificationProfileID"
        },
        "NotificationTemplateID":{
            "$ref":"#/components/schemas/reportProfilesRead/properties/NotificationTemplateID"
        },
        "Archive":{
            "$ref":"#/components/schemas/reportProfilesRead/properties/Archive"
        },
        "ArchiveExpireDays":{
            "$ref":"#/components/schemas/reportProfilesRead/properties/ArchiveExpireDays"
        },
        "ReportFormat":{
            "$ref":"#/components/schemas/reportProfilesRead/properties/ReportFormat"
        },
        "Autosize":{
            "$ref":"#/components/schemas/reportProfilesRead/properties/Autosize"
        },
        "Width":{
            "$ref":"#/components/schemas/reportProfilesRead/properties/Width"
        },
        "Height":{
            "$ref":"#/components/schemas/reportProfilesRead/properties/Height"
        },
        "Zoom":{
            "$ref":"#/components/schemas/reportProfilesRead/properties/Zoom"
        },
        "DataFormat":{
            "$ref":"#/components/schemas/reportProfilesRead/properties/DataFormat"
        },
        "Orientation":{
            "$ref":"#/components/schemas/reportProfilesRead/properties/Orientation"
        },
        "PageSize":{
            "$ref":"#/components/schemas/reportProfilesRead/properties/PageSize"
        },
        "ManualPageSize":{
            "$ref":"#/components/schemas/reportProfilesRead/properties/ManualPageSize"
        }
    },
    "type":"object"
}

Response

Supported Media Types

application/json

200 Response

Successful operation

Root Schema : schema

Match All

Show Source

object SuccessfulAddOperation

The response body for a successful add operation.
object type

{
    "allOf":[
        {
            "$ref":"#/components/schemas/SuccessfulAddOperation"
        },
        {
            "type":"object",
            "properties":{
                "total":{
                    "description":"The total number of results regardless of paging.",
                    "type":"integer",
                    "example":"1"
                },
                "data":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/reportProfilesRead"
                    }
                }
            }
        }
    ]
}

Nested Schema : SuccessfulAddOperation

Type: object

The response body for a successful add operation.

Show Source

message: string

The response message.

Example: Added record
success: boolean

Whether the operation was a success (true) or a failure (false).

Example: true

{
    "description":"The response body for a successful add operation.",
    "properties":{
        "success":{
            "description":"Whether the operation was a success (<b>true</b>) or a failure (<b>false</b>).",
            "type":"boolean",
            "example":"true"
        },
        "message":{
            "description":"The response message.",
            "type":"string",
            "example":"Added record"
        }
    },
    "type":"object"
}

Nested Schema : type

Type: object

Show Source

data: array data
total: integer

The total number of results regardless of paging.

Example: 1

{
    "type":"object",
    "properties":{
        "total":{
            "description":"The total number of results regardless of paging.",
            "type":"integer",
            "example":"1"
        },
        "data":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/reportProfilesRead"
            }
        }
    }
}

Nested Schema : data

Type: array

Show Source

Array of: object reportProfilesRead

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/reportProfilesRead"
    }
}

Nested Schema : reportProfilesRead

Type: object

Show Source

Archive: integer

Checkbox to indicate whether the report results will be archived in the file repository or not. Allowed Values: - 0 => Disabled - 1 => Enabled

Example: 1
ArchiveDisplay: string

Display of the archived reports. Allowed values: - Yes - No

Example: Yes
ArchiveExpireDays: integer

Number of days to keep archived reports before they expire. It is Required when Archive is 1.

Example: 30
Autosize: integer

Flag indicating whether the report runner should calculate width and height for the image or pdf Allowed Values: - 0 => Use user defined configuration - 1 => Autosize

Example: 1
DataFormat: string

If Report Format is set to "Data Export", the type of file that is generated. Allowed Values: - Excel 2007+(*.xlsx) - Excel 97-2003(*.xls) - CSV - Hypertext(*.html) - PDF

Example: Excel 2007+(*.xlsx)
Format: string

The type of output the report will produce. Allowed Values: - PNG - PDF - Data Export

Example: PDF
Height: integer

Height of the output in pixels

Example: 1800
ManualPageSize: string

If Page Size is set to "Manual", a string explaining the page size to use in the PDF. Examples are "5in*7.5in", "10cm*20cm", "A4", "Letter".

Example: Letter
NotificationProfileID: integer

The profile ID used to notify the recipients that the scheduled report is ready.

Example: 1
NotificationProfileName: string

The profile name used to notify the recipients that the scheduled report is ready.

Example: Generic Email
NotificationTemplateID: integer

The template ID used to notify the recipients that the scheduled report is ready.

Example: 3
NotificationTemplateName: string

The template used to notify the recipients that the scheduled report is ready.

Example: Unified Assurance Report - Attachment
Orientation: string

Page orientation used by PDF Allowed Values: - Landscape - Portrait

Example: Landscape
PageSize: string

If Report Format is set to "PDF", the page size for the PDF to use. Allowed Values: - A4 - Letter - Manual

Example: Letter
ReportFormat: string

The type of output the report will produce. Allowed Values: - PNG - PDF - Data Export

Example: PDF
ReportProfileID: integer

Report Profile ID

Example: 2
ReportProfileName: string

The identifier for the profile.

Example: Sample Attachment Profile
Width: integer

Width of the output in pixels

Example: 1024
Zoom: number

PDF Zoom level needed to scale content

Example: 1

{
    "properties":{
        "ReportProfileID":{
            "description":"Report Profile ID",
            "type":"integer",
            "example":"2"
        },
        "ReportProfileName":{
            "description":"The identifier for the profile.",
            "type":"string",
            "example":"Sample Attachment Profile"
        },
        "NotificationProfileID":{
            "description":"The profile ID used to notify the recipients that the scheduled report is ready.",
            "type":"integer",
            "example":"1"
        },
        "NotificationProfileName":{
            "description":"The profile name used to notify the recipients that the scheduled report is ready.",
            "type":"string",
            "example":"Generic Email"
        },
        "NotificationTemplateID":{
            "description":"The template ID used to notify the recipients that the scheduled report is ready.",
            "type":"integer",
            "example":"3"
        },
        "NotificationTemplateName":{
            "description":"The template used to notify the recipients that the scheduled report is ready.",
            "type":"string",
            "example":"Unified Assurance Report - Attachment"
        },
        "Archive":{
            "description":"Checkbox to indicate whether the report results will be archived in the file repository or not.\n\nAllowed Values:\n-  0 => Disabled\n-  1 => Enabled",
            "type":"integer",
            "example":"1"
        },
        "ArchiveDisplay":{
            "description":"Display of the archived reports.\n\nAllowed values:\n- Yes\n- No",
            "type":"string",
            "example":"Yes"
        },
        "Format":{
            "description":"The type of output the report will produce.\n\nAllowed Values:\n-  PNG\n-  PDF\n-  Data Export",
            "type":"string",
            "example":"PDF"
        },
        "ArchiveExpireDays":{
            "description":"Number of days to keep archived reports before they expire. It is Required when Archive is 1.",
            "type":"integer",
            "example":"30"
        },
        "Height":{
            "description":"Height of the output in pixels",
            "type":"integer",
            "example":"1800"
        },
        "Width":{
            "description":"Width of the output in pixels",
            "type":"integer",
            "example":"1024"
        },
        "Zoom":{
            "description":"PDF Zoom level needed to scale content",
            "type":"number",
            "example":"1"
        },
        "Orientation":{
            "description":"Page orientation used by PDF\n\nAllowed Values:\n-  Landscape\n-  Portrait",
            "type":"string",
            "example":"Landscape"
        },
        "PageSize":{
            "description":"If Report Format is set to \"PDF\", the page size for the PDF to use.\n\nAllowed Values:\n-  A4\n-  Letter\n-  Manual",
            "type":"string",
            "example":"Letter"
        },
        "ManualPageSize":{
            "description":"If Page Size is set to \"Manual\", a string explaining the page size to use in the PDF. Examples are \"5in*7.5in\", \"10cm*20cm\", \"A4\", \"Letter\".",
            "type":"string",
            "example":"Letter"
        },
        "Autosize":{
            "description":"Flag indicating whether the report runner should calculate width and height for the image or pdf\n\nAllowed Values:\n-  0 => Use user defined configuration\n-  1 => Autosize",
            "type":"integer",
            "example":"1"
        },
        "ReportFormat":{
            "description":"The type of output the report will produce.\n\nAllowed Values:\n-  PNG\n-  PDF\n-  Data Export",
            "type":"string",
            "example":"PDF"
        },
        "DataFormat":{
            "description":"If Report Format is set to \"Data Export\", the type of file that is generated.\n\nAllowed Values:\n-  Excel 2007+(*.xlsx)\n-  Excel 97-2003(*.xls)\n-  CSV\n-  Hypertext(*.html)\n-  PDF",
            "type":"string",
            "example":"Excel 2007+(*.xlsx)"
        }
    },
    "type":"object"
}

Default Response

Failed operation

Root Schema : schema

Type: object

Show Source

errors: array errors

The list of errors reported. Validation errors will be keyed by record field.
message: string

The response message.

Example: Exception thrown
success: boolean

Whether the operation was a success (true) or a failure (false).

Example: false

{
    "properties":{
        "success":{
            "description":"Whether the operation was a success (<b>true</b>) or a failure (<b>false</b>).",
            "type":"boolean",
            "example":"false"
        },
        "message":{
            "description":"The response message.",
            "type":"string",
            "example":"Exception thrown"
        },
        "errors":{
            "description":"The list of errors reported. Validation errors will be keyed by record field.",
            "type":"array",
            "items":{
                "description":"An error.",
                "type":"object"
            }
        }
    },
    "type":"object"
}

Nested Schema : errors

Type: array

The list of errors reported. Validation errors will be keyed by record field.

Show Source

Array of: object items

An error.

{
    "description":"The list of errors reported. Validation errors will be keyed by record field.",
    "type":"array",
    "items":{
        "description":"An error.",
        "type":"object"
    }
}

Nested Schema : items

Type: object

An error.