SELECT PRODUCT

Roadmap to CloudBees CD APIs
Using DSL
DSL method reference
Using the RESTful API
Using the Perl API
Perl API response and element glossary
Perl API reference
Using the Groovy API
Groovy API reference
aclaclentryactualparameteractualparametersapplicationapplicationdependencyapplicationservicemappingapplicationtierarchiveconnectorartifactartifactversioncatalogcatalogitemcatalogitemruncibuilddetailciconfigurationclustercomponentcontainercredentialdashboarddashboardcolumndataretentionpolicydeployerapplicationdeployerconfigurationdeployerservicedeploymenthistoryitemdevopsinsightdatasourcedirectoryprovideremailconfigemailnotifierentitychangeenvironmentenvironmentinventoryitemenvironmentmapenvironmenttemplateenvironmenttemplatetierenvironmenttemplatetiermapenvironmenttemplatetiermappingenvironmenttierenvironmentvariableenvtempltierresourcetemplmappingeventsubscriptionflowruntimeformaloutputparameterformalparametergategatewaygrouphookjobjobstepkerberoskeytablicensenoteobjectoutputparameterpersonapersonacategorypersonapagepipelinepluginportprocedureprocedurestepprocessprocessdependencyprocessstepprojectpropertyreleasereportreportingfilterreportobjectassociationreportobjectattributereportobjecttyperepositoryreservationresourceresourcepoolresourcetemplateresourceusageretrievedartifactsrollingdeployphaserundiscoverysamlidentityprovidersamlserviceproviderschedulesearchfilterserverserviceaccountserviceserviceclustermappingservicedependencyservicemapdetailsessionsnapshotstagestatestatedefinitiontagtasktiermaptiermappingtransitiontransitiondefinitionuserutilityresourcewaitdependencywidgetwidgetfilteroverrideworkflowworkflowdefinitionworkitemworkspacezone

DevOpsInsightDataSource

createDevOpsInsightDataSource

Create a new DevOps Insight data source.

Arguments

Argument Name Type Description

releaseName

String

The name of the release (Required)

devOpsInsightDataSourceName

String

The DevOps Insight data source name. (Required)

projectName

String

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

description

String

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

pluginKey

String

The plugin key, e.g., EC-MyPlugin

pluginParameters

 
array

The plugin parameters to be passed to the plugin for creating the required schedule and polling procedure

reportObjectTypeName

String

The name of a report object type.

Usage

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


ElectricFlow ef = new ElectricFlow()

def result = ef.createDevOpsInsightDataSource(
                releaseName: 'test-releaseName',
                devOpsInsightDataSourceName: 'test-devOpsInsightDataSourceName',
                projectName: 'test-projectName'
                /* optional arguments */)

deleteDevOpsInsightDataSource

Deletes a DevOps Insight data source

Arguments

Argument Name Type Description

releaseName

String

The name of the release (Required)

devOpsInsightDataSourceName

String

The DevOps Insight data source name. (Required)

projectName

String

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

Usage

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


ElectricFlow ef = new ElectricFlow()

def result = ef.deleteDevOpsInsightDataSource(
                releaseName: 'test-releaseName',
                devOpsInsightDataSourceName: 'test-devOpsInsightDataSourceName',
                projectName: 'test-projectName')

getDevOpsInsightDataSource

Create a new DevOps Insight data source.

Arguments

Argument Name Type Description

releaseName

String

The name of the release (Required)

devOpsInsightDataSourceName

String

The DevOps Insight data source name. (Required)

projectName

String

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

Usage

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


ElectricFlow ef = new ElectricFlow()

def result = ef.getDevOpsInsightDataSource(
                releaseName: 'test-releaseName',
                devOpsInsightDataSourceName: 'test-devOpsInsightDataSourceName',
                projectName: 'test-projectName')

getDevOpsInsightDataSources

Retrieve all DevOps Insight data sources

Arguments

Argument Name Type Description

releaseName

String

The name of the release (Required)

projectName

String

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

reportObjectTypeName

String

The name of a report object type.

Usage

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


ElectricFlow ef = new ElectricFlow()

def result = ef.getDevOpsInsightDataSources(
                releaseName: 'test-releaseName',
                projectName: 'test-projectName'
                /* optional arguments */)

modifyDevOpsInsightDataSource

Modify an existing DevOps Insight data source.

Arguments

Argument Name Type Description

releaseName

String

The name of the release (Required)

devOpsInsightDataSourceName

String

The DevOps Insight data source name. (Required)

projectName

String

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

description

String

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

newName

String

New name for an existing object that is being renamed.

pluginParameters

 
array

The plugin parameters to be passed to the plugin for creating the required schedule and polling procedure

Usage

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


ElectricFlow ef = new ElectricFlow()

def result = ef.modifyDevOpsInsightDataSource(
                releaseName: 'test-releaseName',
                devOpsInsightDataSourceName: 'test-devOpsInsightDataSourceName',
                projectName: 'test-projectName'
                /* optional arguments */)
deploymenthistoryitem
directoryprovider