Change history

2 minute readReference

getDeploymentHistoryItems

Retrieves all the deployment history items for a specific environment.

Arguments

Argument Name Type Description

projectName

String

(Required) Name for the project; must be unique among all projects.

applicationName

String

Application that owns the deployment history item.

environmentName

String

The name of the environment.

environmentProjectName

String

Name for the project to which the environment or environment template belongs to.

latest

Boolean

Retrieves only latest deployment information.

processName

String

Process that owns the deployment history item.

snapshotName

String

Snapshot that owns the deployment history item.

Positional arguments

projectName

Usage

ec-perl

$cmdr->getDeploymentHistoryItems(<projectName>, {<optionals>});

ectool

ectool getDeploymentHistoryItems projectName, [optionals]

getEntityChange

Retrieves the entity changes.

Arguments

Argument Name Type Description

entityId

String

Entity ID.

entityPath

String

Entity path.

entityType

String

Entity type.

modifiedBy

String

User login.

timeSince

Long

Changes since this time. Timeline: [2010 → Since → Until → now].

timeUntil

Long

Changes until this time. If omitted, presumed now. Timeline: [2010 → Since → Until → now].

Positional arguments

None.

Usage

ec-perl

$cmdr->getEntityChange({<optionals>});

ectool

ectool getEntityChange [optionals]

getEntityChangeDetails

Retrieves the differences between entities.

Arguments

Argument Name Type Description

entityId

UUID

(Required) Entity ID.

entityType

String

(Required) Entity type.

revisionNumber

Integer

(Required) Revision number.

Positional arguments

entityId, entityType, revisionNumber

Usage

ec-perl

$cmdr->getEntityChangeDetails(<entityId>, <entityType>, <revisionNumber>);

ectool

ectool getEntityChangeDetails entityId, entityType, revisionNumber

pruneChangeHistory

Prunes obsolete-for-days data from the Change History tables.

Arguments

Argument Name Type Description

daysToKeep

Long

(Required) Number of days' of change history data to keep (minimum seven).

batchedDelete

Boolean

Allows to split records deletion queries by chunks to minimize usage of transaction undo log.

forcePruneAll

Boolean

Override the supplied value of daysToKeep and prune the entire change history, keeping nothing discardable (normally not a good idea — this is mostly intended for testing).

pruneUpgradeObsolete

Boolean

Ignore the supplied value of daysToKeep and instead prune all change data that is obsolete in this version of CloudBees CD/RO. If you make extensive use of Stage entities, and have change history dating from to releases before CloudBees CD/RO 9.0, then running this once after the upgrade to 9.0 should reclaim some database space and might improve change history performance.

Positional arguments

daysToKeep

Usage

ec-perl

$cmdr->pruneChangeHistory(<daysToKeep>, {<optionals>});

ectool

ectool pruneChangeHistory daysToKeep, [optionals]

revert

Reverts the state of the object to a previous state.

You must have the Read, Modify, and Execute permissions to access to this API call.

Arguments

Argument Name Type Description

objectId

UUID

(Required) Object ID.

objectType

String

(Required) Object type.

revisionNumber

Integer

(Required) Revision number.

Positional arguments

objectId, objectType, revisionNumber

Usage

ec-perl

$cmdr->revert(<objectId>, <objectType>, <revisionNumber>);

ectool

ectool revert objectId, objectType, revisionNumber

searchEntityChange

Searches for entity changes.

Arguments

Argument Name Type Description

entityId

String

Entity ID.

entityPath

String

Entity path.

entityType

String

Entity type.

modifiedBy

String

User login.

timeSince

Long

Changes since this time. Timeline: [2010 → Since → Until → now].

timeUntil

Long

Changes until this time. If omitted, presumed now. Timeline: [2010 → Since → Until → now].

Positional arguments

None.

Usage

ec-perl

$cmdr->searchEntityChange({<optionals>});

ectool

ectool searchEntityChange [optionals]