Jump to

• Request
• Response

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

  {
      "required":[
          "property",
          "value"
      ],
      "properties":{
          "property":{
              "description":"The name of the field to filter on.",
              "type":"string",
              "example":"name"
          },
          "value":{
              "description":"The value of the field to filter on.",
              "type":"string",
              "example":"test"
          },
          "operator":{
              "description":"The filter operation to use.",
              "type":"string",
              "default":"LIKE",
              "enum":[
                  "eq",
                  "ne",
                  "gte",
                  "gt",
                  "lte",
                  "lt",
                  "LIKE",
                  "NOT LIKE",
                  "re",
                  "not re",
                  "NOT IN"
              ],
              "example":"eq"
          },
          "conjunction":{
              "description":"The conjunction between filters.",
              "type":"string",
              "default":"OR",
              "enum":[
                  "AND",
                  "OR"
              ],
              "example":"AND"
          }
      },
      "type":"object"
  }

• 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

  {
      "required":[
          "property",
          "direction"
      ],
      "properties":{
          "property":{
              "description":"The field to sort on.",
              "type":"string",
              "example":"name"
          },
          "direction":{
              "description":"The direction of the sort.",
              "type":"string",
              "enum":[
                  "ASC",
                  "DESC"
              ],
              "example":"ASC"
          }
      },
      "type":"object"
  }

• 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 Top

Response

Supported Media Types

• application/json

200 Response

Successful operation

Body ()

Root Schema : schema

Match All

Show Source

• object SuccessfulGetOperation
• object type

{
    "allOf":[
        {
            "$ref":"#/components/schemas/SuccessfulGetOperation"
        },
        {
            "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 : SuccessfulGetOperation

Type: object

Show Source

• message: string
  The response message.

  Example: Loaded 1 entries
• success: boolean
  Whether the operation was a success (true) or a failure (false).

  Example: true

{
    "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":"Loaded 1 entries"
        }
    },
    "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

Body ()

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":{
                "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

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

Nested Schema : items

Type: object

Back to Top