getObjectDslStructure

On this page
Back to index

Summary

Retrieves the DSL structure for a specified object or for all objects in a given type.Use the objectName='exportAll' to export all objects for the specified objectType.The 'exportAll' option is supported for the following objects - archiveConnector, ciConfiguration, complianceConfigurationdataRetentionPolicy, directoryProvider, emailConfig, gateway, group,openIDConnectConfiguration, persona, personaCategory, personaPage,reportObjectType, repository, resource, resourcePool, samlIdentityProvider,samlServiceProvider, serviceAccount, tag, user, workspace, and zone.
For a list of object types in CloudBees CD/RO, refer to Object types in CloudBees CD/RO.
objectId
UUIDoptional
The ID of the object.
objectName
Stringoptional
The name of the object.
objectType
Stringoptional
The type of the object.
path
Stringoptional
A property path indicating a single object for which DSL structure be returned.

Usage

Perl

$cmdr->getObjectDslStructure( # optionals );

ectool

ectool getObjectDslStructure \ # optionals