REST API for Unified Assurance Core

Update a Report

put

/api/report/Reports/{id}

Updates the properties of an existing report specified by the report ID.

Request

Path Parameters

id(required): integer(int32)
The report ID.
Example:
```
1
```

Supported Media Types

application/json

Root Schema : schema

Type: object

Show Source

AppendDateTime: integer

Flag to indicate if the date and time should be appended to the report name.

Example: 1
DashboardID: integer

Dashboard that serves as the basis for the report content

Example: 28
Days: string

The day of the month when the report will be run. Valid entries are "*" which means every day, numbers between 1 and 31 to run on that day of the month, or "*/" can be used to indicate "Every number of days".

Example: *
Footer: string
Determine what extra information is added to the end of the report.
Allowed Values:
- none adds nothing.
- basic adds the date, time, and user the report was run as.
- enhanced adds the basic footer and any parameters that were used to create the report.
Example: basic
Hours: string

The hours when the report will be run. Valid entries are "*" which means every hour, numbers between 0 and 23 to run at that hour, or "*/" can be used to indicate "Every number of hours".

Example: 0
Minutes: string

The minutes when the report will be run. Valid entries are "*" which means every minute, numbers between 0 and 59 to run at that minute, or "*/" can be used to indicate "Every number of minutes".

Example: 0
Months: string

The month when the report will be run. Valid entries are "*" which means every month, numbers between 1 and 12 to run at that minute, or "*/" can be used to indicate "Every number of months".

Example: *
OwnerUserGroupID: integer

The user group that owns the report. If an associated report Profile has archiving enabled, the archived file will also be owned by this group.

Example: 0
OwnerUserID: integer

The ID of the user that owns the report. If an associated Profile enables archiving, the archived file will also be owned by this user. This can never be an externally-authenticated transient user. 0 means it is public to all users in the owning group.

Example: 0
Recipients: string

Email addresses the report notification should be sent to when the report is run.

Example: example@example.com
RenderTimeout: integer

The number of seconds to allow the report to render before capturing the results for the report.

Example: 3
ReportName: string

The report 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: New Report
ReportParameters: string

Parameters to pass to the portal

Example: DeviceID=1
ReportProfileID: integer

Report profile that provides the generic configuration of the report

Example: 2
RunAsUserGroupID: integer

The Unified Assurance user group that will run the report. The user group's permissions will be used to determine what data can be included.

Example: 1
RunAsUserID: integer

The Unified Assurance user that will run the report. The user's permissions will be used to determine what data can be included.

Example: 1
StatusID: integer

The report status ID, indicating whether the report is being run (enabled,1), or not (disabled, 0.

Example: 1
Viewers: array Viewers

The user groups that will also have access to the report.
WeekDays: string

The day of the week when the report will be run. Valid entries are "*" which means every day of the week, numbers between 0 and 7 (0/7 = Sunday, 1 = Monday, 2 = Tuesday, 3 = Wednesday, 4 = Thursday, 5 = Friday, 6 = Saturday), or "*/" can be used to indicate "Every number of days".

Example: *

{
    "properties":{
        "ReportName":{
            "description":"The report 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":"New Report"
        },
        "AppendDateTime":{
            "$ref":"#/components/schemas/reportReportsRead/properties/AppendDateTime"
        },
        "ReportProfileID":{
            "$ref":"#/components/schemas/reportReportsRead/properties/ReportProfileID"
        },
        "DashboardID":{
            "$ref":"#/components/schemas/reportReportsRead/properties/DashboardID"
        },
        "ReportParameters":{
            "$ref":"#/components/schemas/reportReportsRead/properties/ReportParameters"
        },
        "Recipients":{
            "$ref":"#/components/schemas/reportReportsRead/properties/Recipients"
        },
        "Footer":{
            "$ref":"#/components/schemas/reportReportsRead/properties/Footer"
        },
        "RenderTimeout":{
            "$ref":"#/components/schemas/reportReportsRead/properties/RenderTimeout"
        },
        "StatusID":{
            "$ref":"#/components/schemas/reportReportsRead/properties/StatusID"
        },
        "RunAsUserGroupID":{
            "$ref":"#/components/schemas/reportReportsRead/properties/RunAsUserGroupID"
        },
        "RunAsUserID":{
            "$ref":"#/components/schemas/reportReportsRead/properties/RunAsUserID"
        },
        "OwnerUserID":{
            "$ref":"#/components/schemas/reportReportsRead/properties/OwnerUserID"
        },
        "OwnerUserGroupID":{
            "$ref":"#/components/schemas/reportReportsRead/properties/OwnerUserGroupID"
        },
        "Viewers":{
            "description":"The user groups that will also have access to the report.",
            "type":"array",
            "items":{
            },
            "example":[
                0
            ]
        },
        "Minutes":{
            "$ref":"#/components/schemas/reportReportsRead/properties/Minutes"
        },
        "Hours":{
            "$ref":"#/components/schemas/reportReportsRead/properties/Hours"
        },
        "Days":{
            "$ref":"#/components/schemas/reportReportsRead/properties/Days"
        },
        "Months":{
            "$ref":"#/components/schemas/reportReportsRead/properties/Months"
        },
        "WeekDays":{
            "$ref":"#/components/schemas/reportReportsRead/properties/WeekDays"
        }
    },
    "type":"object"
}

Nested Schema : Viewers

Type: array

The user groups that will also have access to the report.

Show Source

Array of:

{
    "description":"The user groups that will also have access to the report.",
    "type":"array",
    "items":{
    },
    "example":[
        0
    ]
}

Example:

[
    0
]

Response

Supported Media Types

application/json

200 Response

Successful operation

Root Schema : schema

Match All

Show Source

object SuccessfulUpdateOperation

The response body for a successful update operation.
object type

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

Nested Schema : SuccessfulUpdateOperation

Type: object

The response body for a successful update operation.

Show Source

message: string

The response message.

Example: Updated record
success: boolean

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

Example: true

{
    "description":"The response body for a successful update 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":"Updated 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/reportReportsRead"
            }
        }
    }
}

Nested Schema : data

Type: array

Show Source

Array of: object reportReportsRead

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

Nested Schema : reportReportsRead

Type: object

Show Source

AppendDateTime: integer

Flag to indicate if the date and time should be appended to the report name.

Example: 1
BrokerComponentID: integer

Broker component that will carry out generation of the report

Example: 55
DashboardID: integer

Dashboard that serves as the basis for the report content

Example: 28
DashboardName: string

Dashboard name that serves as the basis for the report content

Example: Adhoc Event Dashboard
Days: string

The day of the month when the report will be run. Valid entries are "*" which means every day, numbers between 1 and 31 to run on that day of the month, or "*/" can be used to indicate "Every number of days".

Example: *
Extension: string

Report output format Allowed Values: - png - pdf - csv - xlsx - xls - html

Example: pdf
Footer: string
Determine what extra information is added to the end of the report.
Allowed Values:
- none adds nothing.
- basic adds the date, time, and user the report was run as.
- enhanced adds the basic footer and any parameters that were used to create the report.
Example: basic
FullName: string

User Group name

Example: Administrator
Hours: string

The hours when the report will be run. Valid entries are "*" which means every hour, numbers between 0 and 23 to run at that hour, or "*/" can be used to indicate "Every number of hours".

Example: 0
LastRun: string

Last time the report generator was run.

Example: 2022-11-22 11:43:00
Minutes: string

The minutes when the report will be run. Valid entries are "*" which means every minute, numbers between 0 and 59 to run at that minute, or "*/" can be used to indicate "Every number of minutes".

Example: 0
Months: string

The month when the report will be run. Valid entries are "*" which means every month, numbers between 1 and 12 to run at that minute, or "*/" can be used to indicate "Every number of months".

Example: *
OwnerUserGroupID: integer

The user group that owns the report. If an associated report Profile has archiving enabled, the archived file will also be owned by this group.

Example: 0
OwnerUserID: integer

The ID of the user that owns the report. If an associated Profile enables archiving, the archived file will also be owned by this user. This can never be an externally-authenticated transient user. 0 means it is public to all users in the owning group.

Example: 0
Recipients: string

Email addresses the report notification should be sent to when the report is run.

Example: example@example.com
RenderTimeout: integer

The number of seconds to allow the report to render before capturing the results for the report.

Example: 3
ReportID: integer

Report ID

Example: 1000
ReportName: string

The title to identify the report at a glance.

Example: Sample
ReportParameters: string

Parameters to pass to the portal

Example: DeviceID=1
ReportProfileID: integer

Report profile that provides the generic configuration of the report

Example: 2
ReportProfileName: string

Report profile that provides the generic configuration of the report

Example: Sample Attachment Profile
RunAsUserGroupID: integer

The Unified Assurance user group that will run the report. The user group's permissions will be used to determine what data can be included.

Example: 1
RunAsUserID: integer

The Unified Assurance user that will run the report. The user's permissions will be used to determine what data can be included.

Example: 1
State: integer

State

Example: 0
Status: string

The state of the report.

Example: Enabled
StatusIcon: string

Status Icon

Example: OrbGreen.png
StatusID: integer

The report status ID, indicating whether the report is being run (enabled,1), or not (disabled, 0.

Example: 1
UserName: string

User Name

Example: admin
Viewers: array Viewers

The user groups that will also have access to the report.
WeekDays: string

The day of the week when the report will be run. Valid entries are "*" which means every day of the week, numbers between 0 and 7 (0/7 = Sunday, 1 = Monday, 2 = Tuesday, 3 = Wednesday, 4 = Thursday, 5 = Friday, 6 = Saturday), or "*/" can be used to indicate "Every number of days".

Example: *

{
    "properties":{
        "ReportID":{
            "description":"Report ID",
            "type":"integer",
            "example":"1000"
        },
        "ReportName":{
            "description":"The title to identify the report at a glance.",
            "type":"string",
            "example":"Sample"
        },
        "RenderTimeout":{
            "description":"The number of seconds to allow the report to render before capturing the results for the report.",
            "type":"integer",
            "example":"3"
        },
        "RunAsUserID":{
            "description":"The Unified Assurance user that will run the report. The user's permissions will be used to determine what data can be included.",
            "type":"integer",
            "example":"1"
        },
        "UserName":{
            "description":"User Name",
            "type":"string",
            "example":"admin"
        },
        "RunAsUserGroupID":{
            "description":"The Unified Assurance user group that will run the report. The user group's permissions will be used to determine what data can be included.",
            "type":"integer",
            "example":"1"
        },
        "Recipients":{
            "description":"Email addresses the report notification should be sent to when the report is run.",
            "type":"string",
            "example":"example@example.com"
        },
        "StatusID":{
            "description":"The report status ID, indicating whether the report is being run (enabled,<b>1</b>), or not (disabled, <b>0</b>.",
            "type":"integer",
            "example":"1"
        },
        "OwnerUserID":{
            "description":"The ID of the user that owns the report. If an associated Profile enables archiving, the archived file will also be owned by this user. This can never be an externally-authenticated transient user. <b>0</b> means it is public to all users in the owning group.",
            "type":"integer",
            "example":"0"
        },
        "OwnerUserGroupID":{
            "description":"The user group that owns the report. If an associated report Profile has archiving enabled, the archived file will also be owned by this group.",
            "type":"integer",
            "example":"0"
        },
        "DashboardID":{
            "description":"Dashboard that serves as the basis for the report content",
            "type":"integer",
            "example":"28"
        },
        "DashboardName":{
            "description":"Dashboard name that serves as the basis for the report content",
            "type":"string",
            "example":"Adhoc Event Dashboard"
        },
        "ReportProfileID":{
            "description":"Report profile that provides the generic configuration of the report",
            "type":"integer",
            "example":"2"
        },
        "ReportProfileName":{
            "description":"Report profile that provides the generic configuration of the report",
            "type":"string",
            "example":"Sample Attachment Profile"
        },
        "BrokerComponentID":{
            "description":"Broker component that will carry out generation of the report",
            "type":"integer",
            "example":"55"
        },
        "FullName":{
            "description":"User Group name",
            "type":"string",
            "example":"Administrator"
        },
        "Status":{
            "description":"The state of the report.",
            "type":"string",
            "example":"Enabled"
        },
        "StatusIcon":{
            "description":"Status Icon",
            "type":"string",
            "example":"OrbGreen.png"
        },
        "Footer":{
            "description":"Determine what extra information is added to the end of the report. \n<br>Allowed Values:\n<ul><li><b>none</b> adds nothing.</li>\n<li><b>basic</b> adds the date, time, and user the report was run as.</li>\n<li><b>enhanced</b> adds the basic footer and any parameters that were used to create the report.</li></ul>",
            "type":"string",
            "example":"basic"
        },
        "State":{
            "description":"State",
            "type":"integer",
            "example":"0"
        },
        "LastRun":{
            "description":"Last time the report generator was run.",
            "type":"string",
            "example":"2022-11-22 11:43:00"
        },
        "AppendDateTime":{
            "description":"Flag to indicate if the date and time should be appended to the report name.",
            "type":"integer",
            "example":"1"
        },
        "ReportParameters":{
            "description":"Parameters to pass to the portal",
            "type":"string",
            "example":"DeviceID=1"
        },
        "Minutes":{
            "description":"The minutes when the report will be run. Valid entries are \"*\" which means every minute, numbers between 0 and 59 to run at that minute, or \"*/\" can be used to indicate \"Every number of minutes\".",
            "type":"string",
            "example":"0"
        },
        "Hours":{
            "description":"The hours when the report will be run. Valid entries are \"*\" which means every hour, numbers between 0 and 23 to run at that hour, or \"*/\" can be used to indicate \"Every number of hours\".",
            "type":"string",
            "example":"0"
        },
        "Days":{
            "description":"The day of the month when the report will be run. Valid entries are \"*\" which means every day, numbers between 1 and 31 to run on that day of the month, or \"*/\" can be used to indicate \"Every number of days\".",
            "type":"string",
            "example":"*"
        },
        "Months":{
            "description":"The month when the report will be run. Valid entries are \"*\" which means every month, numbers between 1 and 12 to run at that minute, or \"*/\" can be used to indicate \"Every number of months\".",
            "type":"string",
            "example":"*"
        },
        "WeekDays":{
            "description":"The day of the week when the report will be run. Valid entries are \"*\" which means every day of the week, numbers between 0 and 7 (0/7 = Sunday, 1 = Monday, 2 = Tuesday, 3 = Wednesday, 4 = Thursday, 5 = Friday, 6 = Saturday), or \"*/\" can be used to indicate \"Every number of days\".",
            "type":"string",
            "example":"*"
        },
        "Extension":{
            "description":"Report output format\nAllowed Values:\n-  png\n-  pdf\n-  csv\n-  xlsx\n-  xls\n-  html",
            "type":"string",
            "example":"pdf"
        },
        "Viewers":{
            "description":"The user groups that will also have access to the report.",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "UserGroupID":{
                        "description":"User Group ID",
                        "type":"integer",
                        "example":"0"
                    },
                    "UserGroupName":{
                        "description":"User Group Name",
                        "type":"string",
                        "example":"[Public to All Groups]"
                    }
                }
            }
        }
    },
    "type":"object"
}

Nested Schema : Viewers

Type: array

The user groups that will also have access to the report.

Show Source

Array of: object items

{
    "description":"The user groups that will also have access to the report.",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "UserGroupID":{
                "description":"User Group ID",
                "type":"integer",
                "example":"0"
            },
            "UserGroupName":{
                "description":"User Group Name",
                "type":"string",
                "example":"[Public to All Groups]"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

UserGroupID: integer

User Group ID

Example: 0
UserGroupName: string

User Group Name

Example: [Public to All Groups]

{
    "type":"object",
    "properties":{
        "UserGroupID":{
            "description":"User Group ID",
            "type":"integer",
            "example":"0"
        },
        "UserGroupName":{
            "description":"User Group Name",
            "type":"string",
            "example":"[Public to All Groups]"
        }
    }
}

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.