Prompt Fields

Reports can contain Prompt Fields. The prompts command returns some information about the prompt fields of the given report.

GET /api/reporting/report/prompts

Request the list of prompt fields set for a given report. Requires the parameter report to be set.

REQUEST Fields Value Type Description
report string The location of the report
RESPONSE Fields Value Type Description
name string The name of the prompt field
type number The number of the type
typeName string The readable name of the prompt field type

Example Request

# Request
GET /api/reporting/report/prompts?report=myPromptReport.rpt  HTTP/1.1
Authorization: Bearer VGhpcyBpcyBqdXN0IGEgZGVtbyBhY2Nlc3MgdG9rZW4u
 
# Response - Task will be executed
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: <CONTENT LENGTH>
 
[
  {
    "name": "stringPrompt",
    "typeName": "STRING",
    "type": 11
  },
  {
    "name": "#1#subReportStringPrompt",
    "typeName": "STRING",
    "type": 11
  }
]

Application Example

# Browser access
http://127.0.0.1:9000/api/reporting/report/prompts?report=myPromptReport.rpt
 
# Shell access using curl
curl -LsH "Authorization: Bearer <access_token>" "http://127.0.0.1:9000/api/reporting/report/prompts?report=myPromptReport.rpt"
 
# Shell access using curl using username and password
curl -Lsu username:password "http://127.0.0.1:9000/api/reporting/report/prompts?report=myPromptReport.rpt"