Table of Contents

Search

  1. Preface
  2. Introduction to Business Entity Services
  3. EJB Business Entity Service Calls
  4. REST Business Entity Service Calls
  5. REST APIs for Data Director
  6. SOAP Business Entity Service Calls
  7. Cross-reference Records and BVT Calculations Services
  8. Supporting Corporate Linkage Service
  9. External Calls to Cleanse, Analyze, and Transform Data
  10. Appendix A: Using REST APIs to Add Records
  11. Appendix B: Using REST APIs to Upload Files
  12. Appendix C: Using REST APIs to Manage Reports

Response Body

Response Body

The response includes the report configuration and data.
The following table describes the parameters in the response body:
Parameter
Description
metadata
Includes the report configuration.
ROWID_RPT_CONFIG
ID of report.
DIMENSION_NAME_1
The name of a dimension of data in the report. For example, a dimension might be User Name, Review task type, or business entity type.
DIMENSION_NAME_2
Optional. The name of a dimension of data in the report. For example, a dimension might be User Name, Review task type, or business entity type.
TIMEPERIOD_NAME
Optional. Name of the period of time to which the data applies. For example, you might specify
Month
.
RPT_NAME
Name of the report.
METRIC_NAME
Label for the type of data collected by the report. By default, the value specified for this parameter appears as the name of the y-axis in the chart. For example, you might have a report that collects information about closed tasks by user. You might use the metric name
Number of closed tasks
.
RPT_DESC
Description of the report.
RPT_TYPE
Indicates whether the report is a drilldown report. If the value is
null
, then the report is a root report. If the value is anything other than
null
, then the report is a drilldown report.
fieldsMetadata
Lists the fields in a report data array. Values include
DIMENSION_VALUE_1
,
DIMENSION_VALUE_2
,
TIMEPERIOD_VALUE
,
METRIC_VALUE
, and
DRILLDOWN_RPT_ID
.
data
Lists the values for each field in a report data array.

0 COMMENTS

We’d like to hear from you!