Note commands

createNote

Creates a new note.

Arguments

Argument Name Type Description

projectName

String

projectName of the entity that owns the note

releaseName

String

Name of the release

note

String

This represents the notes provided about the entity

noteName

String

The name of the note.

Usage

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


ElectricFlow ef = new ElectricFlow()

def result = ef.createNote(
                /* optional arguments */)

deleteNote

Deletes a note associated with an entity.

Arguments

Argument Name Type Description

noteName

String

The name of the note. (Required)

projectName

String

projectName of the entity that owns the note

releaseName

String

Name of the release

Usage

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


ElectricFlow ef = new ElectricFlow()

def result = ef.deleteNote(
                noteName: 'test-noteName')

getNote

Get a note associated with an entity.

Arguments

Argument Name Type Description

noteName

String

The name of the note. (Required)

projectName

String

projectName of the entity that owns the note

releaseName

String

Name of the release

Usage

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


ElectricFlow ef = new ElectricFlow()

def result = ef.getNote(
                noteName: 'test-noteName')

getNotes

Get all Notes associated with an entity.

Arguments

Argument Name Type Description

projectName

String

projectName of the entity that owns the note

releaseName

String

Name of the release

Usage

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


ElectricFlow ef = new ElectricFlow()

def result = ef.getNotes()

modifyNote

Modifies a note.

Arguments

Argument Name Type Description

projectName

String

projectName of the entity that owns the note

releaseName

String

Name of the release

noteName

String

The name of the note.

newName

String

New name for an existing object that is being renamed.

note

String

This represents the notes provided about the entity

Usage

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


ElectricFlow ef = new ElectricFlow()

def result = ef.modifyNote(
                /* optional arguments */)