# List ReportDefinition

Lists all ReportDefinition

Endpoint: GET /report-definitions
Version: v1
Security: apiKeyAuth, bearerAuth

## Header parameters:

  - `vbasoftware-database` (string, required)
    Target database

## Query parameters:

  - `criteriaObject` (string)
    Criteria Object

  - `page` (integer)
    Page

  - `pageSize` (integer)
    Page Size

  - `sortBy` (string)
    Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., 'Property1:desc,Property2:asc,Property3:asc' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.

## Response 200 fields (text/plain):

  - `data` (array,null)

  - `data.reportDefinition_Key` (integer, required)
    ID of the report definition. Note: This field is marked as NOT NULL in the database and therefore required by the API.

  - `data.bR_Report_ID` (string,null)
    Contains the GUID for the corresponding Advanced Reporting ID in Bold Reports.

  - `data.combine_Navigation` (boolean, required)
    This will combine the results of a criteria window with multiple criteria. Note: This field is marked as NOT NULL in the database and therefore required by the API.

  - `data.criteria_Object` (string,null)
    The PowerBuilder object used to enter criteria.

  - `data.custom_Report` (string,null)
    Identifies a custom report to be used.

  - `data.entry_Date` (string)
    Date record was first added to the system

  - `data.entry_User` (string,null)
    User that first added the record to the system

  - `data.exclude_Adjustment_Category` (boolean, required)
    Flag indicating if the adjustment category should be excluded from the report Note: This field is marked as NOT NULL in the database and therefore required by the API.

  - `data.exclude_Other_Category` (boolean, required)
    Flag indicating if the other category should be excluded from the report Note: This field is marked as NOT NULL in the database and therefore required by the API.

  - `data.exclude_Total_Category` (boolean, required)
    Flag indicating if the total category should be excluded from the report Note: This field is marked as NOT NULL in the database and therefore required by the API.

  - `data.group_Categories_Only` (boolean, required)
    Limits the report to only showing Rate Categories defined at the Group, not all Rate Categories on the Invoice. Note: This field is marked as NOT NULL in the database and therefore required by the API.

  - `data.help_File` (string,null)
    Help file associated with the report object

  - `data.help_Topic_ID` (integer,null)
    Topic ID within the help file associated with the report object

  - `data.invoice_Category_Column_Count` (integer,null)
    Identifies how many category columns are used within the report.

  - `data.navigation_Report` (boolean, required)
    Indicates that the report has navigation. Note: This field is marked as NOT NULL in the database and therefore required by the API.

  - `data.report_Category` (string,null)
    Identifies which category the report belongs to.

  - `data.report_Description` (string, required)
    Full description of the report.

  - `data.report_Detail_Object` (string,null)
    Specifies a secondary report that may be used in conjunction with the main report

  - `data.report_Example` (string,null)
    Utilize the file explorer to choose an example of the chosen report.

  - `data.report_ID` (string, required)
    ID of the report being defined.

  - `data.report_Library` (string,null)
    Identifies which report library the User wishes to choose from.

  - `data.report_Name` (string, required)
    Name of the report.

  - `data.report_Object` (string,null)
    Indicates which report will be used with the automation step.

  - `data.schedule_Report` (boolean, required)
    Indicates that the report may be used with scheduling functionality. Note: This field is marked as NOT NULL in the database and therefore required by the API.

  - `data.series_Report` (boolean, required)
    Indicates that the report may be added to a report series. Note: This field is marked as NOT NULL in the database and therefore required by the API.

  - `data.trackable_Report` (boolean, required)
    Indicates that tracking functionality will be used for the report. Note: This field is marked as NOT NULL in the database and therefore required by the API.

  - `data.update_Date` (string)
    Date the record was last updated in the system

  - `data.update_User` (string,null)
    User that last updated the record in the system

  - `data.vbA_Canned_Report` (boolean)

  - `error` (object)

  - `error.detail` (string,null)
    A human-readable explanation specific to this occurrence of the problem.

  - `error.instance` (string,null)
    A URI reference that identifies the specific occurrence of the problem.It may
or may not yield further information if dereferenced.

  - `error.status` (integer)
    The HTTP status code([RFC7231], Section 6) generated by the origin server for
this occurrence of the problem.

  - `error.title` (string,null)
    A short, human-readable summary of the problem type.It SHOULD NOT change from
occurrence to occurrence of the problem, except for purposes of localization(e.g.,
using proactive content negotiation; see[RFC7231], Section 3.4).

  - `error.type` (string,null)
    A URI reference [RFC3986] that identifies the problem type. This specification
encourages that, when dereferenced, it provide human-readable documentation for
the problem type (e.g., using HTML [W3C.REC-html5-20141028]). When this member
is not present, its value is assumed to be "about:blank".

  - `debug` (object)

  - `debug.activityID` (string, required)


## Response 401 fields