createReport

Back to index

Summary

Creates a new report.

projectName

Stringrequired

The name for the project that must be unique among all projects.

reportName

Stringrequired

The name of the report.

definition

Stringoptional

The Elasticsearch query definition to use for retrieving report data.

description

Stringoptional

Comment text describing this object that is not interpreted at all by CloudBees CD/RO.

parameters

Stringoptional

Input parameters in JSON format accepted by the report definition.

reportObjectTypeForSourceType

Stringoptional

The report object type name to use to determine the source type for the report. Set this if the sourceType of the report's reportObjectType is different from the actual source of the report data.

reportObjectTypeName

Stringoptional

Report object type name.

reportQuery

Stringoptional

The report query in JSON format. It will be translated to the Elasticsearch query definition when retrieving report data.

title

Stringoptional

The title of report.

uri

Stringoptional

An advanced mode option for identifying the Elasticsearch URI to use for retrieving report data. By default, the reportObjectTypeName argument will be used to construct the URI based on the Elasticsearch index for the report object, e.g., ef-deployment-*/_search?pretty.

Usage

Groovy

import com.electriccloud.client.groovy.ElectricFlow
import com.electriccloud.client.groovy.models.*

ElectricFlow ef = new ElectricFlow()

def result = ef.createReport(
  projectName: "test-projectName",
  reportName: "test-reportName"
  /* optional arguments */
)▼