Project Management

createProject

Creates a new project.

You must specify a projectName.

Arguments Descriptions

projectName

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

Argument type: String

credentialName

(Optional) Name of the credential in one of these forms:

  • Relative (for example, "cred1" )—The credential is assumed to be in the project that contains the request target object.

  • Absolute (for example, "/projects/BuildProject/credentials/cred1" )—The credential can be from any specified project, regardless of the target object’s project.

Argument type: String

description

(Optional) A plain text or HTML description for this object. If using HTML, you must surround your text with <html> …​ </html> tags. The only HTML tags allowed in the text are: <a> <b> <br> <div> <dl> <font> <i> <li> <ol> <p> <pre> <span> <style> <table> <tc> <td> <th> <tr> <ul>

Argument type: String

resourceName

(Optional)The name of the resource to use as the default for steps run by procedures in this project.

Argument type: String

tracked

(Optional) < Boolean flag - 0|1|true|false > If set to 1 or true, Change Tracking is enabled for the project.

Argument type: Boolean

workspaceName

(Optional) The name of a workspace to use as the default for steps run by procedures in this project.

Argument type: String

Positional arguments

projectName

Response

Returns a project element.

ec-perl

syntax: $cmdr->createProject(<projectName>, {<optionals>});

Example

$cmdr->createProject("Default", {workspaceName => "Primary"});

ectool

syntax: ectool createProject <projectName> [optionals]

Example

ectool createProject "Default" --workspaceName "Primary"

deleteProject

Deletes a project, including all procedures, procedure steps, and jobs within that project.

You must specify a projectName.

Arguments Descriptions

projectName

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

Argument type: String

foreground

(Optional) < Boolean flag - 0|1|true|false >

If the value is 1 or true, the object in the foreground is deleted. The default is to delete the object in the background.

Argument type: Boolean

Positional arguments

projectName

Response

None or a status OK message.

ec-perl

syntax: $cmdr->deleteProject(<projectName>, {<optionals>});

Example

$cmdr->deleteProject("Default", {foreground => true});

ectool

syntax: ectool deleteProject <projectName> [optionals]

Example

ectool deleteProject "Default" --foreground true

getProject

Finds a project by its name.

You must specify a projectName.

Arguments Descriptions

projectName

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

Argument type: String

Positional arguments

projectName

Response

One project element.

ec-perl

syntax: $cmdr->getProject(<projectName>);

Example

$cmdr->getProject("Quarterly Summary");

ectool

syntax: ectool getProject <projectName>

Example

ectool getProject "Quarterly Summary"

getProjects

Retrieves all projects.

Arguments Descriptions

None

Positional arguments

None

Response

Zero or more project elements. Note: This response includes all projects in the system, including plugin projects, which are not displayed on the Projects page in the web UI.

ec-perl

syntax: $cmdr->getProjects();

Example

$cmdr->getProjects();

ectool

syntax: ectool getProjects

Example

ectool getProjects

modifyProject

Modifies an existing project.

You must specify a projectName.

Arguments Descriptions

projectName

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

Argument type: String

credentialName

(Optional) Name of the credential in one of these forms:

  • Relative (for example, "cred1" )—The credential is assumed to be in the project that contains the requested target object.

  • Absolute (for example, "/projects/BuildProject/credentials/cred1" )—The credential can be from any specified project, regardless of the target object’s project.

Argument type: String

description

(Optional) A plain text or HTML description for this object. If using HTML, you must surround your text with <html> …​ </html> tags. The only HTML tags allowed in the text are: <a> <b> <br> <div> <dl> <font> <i> <li> <ol> <p> <pre> <span> <style> <table> <tc> <td> <th> <tr> <ul>

Argument type: String

newName

(Optional) New name of the project.

Argument type: String

resourceName

(Optional) The name of the resource used as the default for steps run by procedures in this project.

Argument type: String

tracked

(Optional) < Boolean flag - 0|1|true|false >

If set to 1 or true, Change Tracking is enabled for the project.

Argument type: Boolean

workspaceName

(Optional) The name of the default workspace where job output is stored.

Argument type: String

Positional arguments

projectName

Response

Returns a modified project object.

ec-perl

syntax: $cmdr->modifyProject(<projectName>, {<optionals>});

Examples

To change the project description:

$cmdr->modifyProject("Default", {description => "A very simple project"});

To enable Change Tracking for the Default project:

$cmdr->modifyProject("Default", {tracked => true});

ectool

syntax: ectool modifyProject <projectName> [optionals]

Examples

To change the project description:

ectool modifyProject "Default" --description "A very simple project"

To enable Change Tracking for the Default project:

ectool modifyProject "Default" --tracked true

reloadSetupScripts

Runs new, modified, or previously unsuccessful setup scripts.

Arguments Descriptions

None

Positional arguments

None

Response

None or a status OK message.

ec-perl

syntax: $cmdr->reloadSetupScripts ();

Example

$cmdr->reloadSetupScripts ();

ectool

syntax: ectool reloadSetupScripts

Example

ectool reloadSetupScripts