Get Report Profiles
get
/api/report/Profiles
Gets a list of all report profiles and their attributes that match the specified parameters. If no parameters are specified, all report profiles and their attributes are returned.
Request
Query Parameters
-
filter: object
The fields to filter the results by. You cannot filter by fields that contain a state.
This parameter's value uses the following JSON format:
{
"property": "property",
"value": "propertyValue",
"operator": "operator",
"conjunction": "conjunction"
}
If you use multiple JSON objects to combine filters, for example, to filter by several different device names, you cannot combine OR and AND conjunctions. The conjunction used for the last object applies to the entire list.-
conjunction:
string
Default Value:
OR
Allowed Values:[ "AND", "OR" ]
The conjunction between filters.Example:AND
-
operator:
string
Default Value:
LIKE
Allowed Values:[ "eq", "ne", "gte", "gt", "lte", "lt", "LIKE", "NOT LIKE", "re", "not re", "NOT IN" ]
The filter operation to use.Example:eq
-
property(required):
string
The name of the field to filter on.Example:
name
-
value(required):
string
The value of the field to filter on.Example:
test
-
conjunction:
string
-
limit: integer(int32)
The number of records to limit results by.Example:
100
-
sort: object
The field and direction to sort results by. You cannot sort by fields that contain a state.
This parameters value uses the following JSON format:
{
"property": "property",
"direction": "direction"
}-
direction(required):
string
Allowed Values:
[ "ASC", "DESC" ]
The direction of the sort.Example:ASC
-
property(required):
string
The field to sort on.Example:
name
-
direction(required):
string
-
start: integer(int32)
The page of results to start from.Default Value:
0
Example:1
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
200 Response
Successful operation
Nested Schema : SuccessfulGetOperation
Type:
Show Source
object
-
message: string
The response message.Example:
Loaded 1 entries
-
success: boolean
Whether the operation was a success (true) or a failure (false).Example:
true
Nested Schema : type
Type:
Show Source
object
-
data: array
data
-
total: integer
The total number of results regardless of paging.Example:
1
Nested Schema : reportProfilesRead
Type:
Show Source
object
-
Archive: integer
Checkbox to indicate whether the report results will be archived in the file repository or not. Allowed Values: - 0 => Disabled - 1 => EnabledExample:
1
-
ArchiveDisplay: string
Display of the archived reports. Allowed values: - Yes - NoExample:
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 => AutosizeExample:
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) - PDFExample:
Excel 2007+(*.xlsx)
-
Format: string
The type of output the report will produce. Allowed Values: - PNG - PDF - Data ExportExample:
PDF
-
Height: integer
Height of the output in pixelsExample:
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 - PortraitExample:
Landscape
-
PageSize: string
If Report Format is set to "PDF", the page size for the PDF to use. Allowed Values: - A4 - Letter - ManualExample:
Letter
-
ReportFormat: string
The type of output the report will produce. Allowed Values: - PNG - PDF - Data ExportExample:
PDF
-
ReportProfileID: integer
Report Profile IDExample:
2
-
ReportProfileName: string
The identifier for the profile.Example:
Sample Attachment Profile
-
Width: integer
Width of the output in pixelsExample:
1024
-
Zoom: number
PDF Zoom level needed to scale contentExample:
1
Default Response
Failed operation
Root Schema : schema
Type:
Show Source
object
-
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
Nested Schema : errors
Type:
array
The list of errors reported. Validation errors will be keyed by record field.
Show Source
Nested Schema : items
Type:
object