Object

applicationName

String

The name of an application.

applicationTierName

String

The name of an application tier.

archiveConnectorName

String

The name of an archive connector.

artifactName

String

The name of the artifact container of the property sheet which owns the property.

artifactVersionName

String

The name of the artifactVersion container of the property sheet which owns the property.

catalogName

String

The name of the catalog of the property sheet which owns the property.

ciBuildDetailName

String

The name of the CI build detail of the property sheet which owns the property.

clusterName

String

The name of the cluster which owns property sheet.

componentName

String

The name of a component.

configName

String

The name of the email configuration.

credentialName

String

The name of the credential.

dashboardName

String

The name of a dashboard.

dataRetentionPolicyName

String

The name of a data retention policy.

environmentName

String

The name of an environment.

environmentTemplateName

String

The name of an environment template.

environmentTemplateTierName

String

The name of the environment template tier container of the property sheet which owns the property.

environmentTierName

String

The name of an environment tier.

flowName

String

The name of the flow container of the property sheet which owns the property.

flowRuntimeId

String

The ID of the flow runtime container of the property sheet which owns the property.

flowRuntimeName

String

The name of the flow runtime container of the property sheet which owns the property.

flowRuntimeStateId

String

The primary key or name of the flowRuntimeState container of the property sheet which owns the property.

flowRuntimeStateName

String

The name of the flow state container of the property sheet which owns the property.

flowStateName

String

The name of the flow state container of the property sheet which owns the property.

flowTransitionName

String

The name of the flow transition container of the property sheet which owns the property.

gateType

String

The type of the gate which owns property sheet.

gatewayName

String

The name of the gateway container of the property sheet.

groupName

String

The name of a group.

jobId

String

The primary key or name of the job container of the property sheet which owns the property.

jobStepId

String

The primary key of the job-step container of the property sheet which owns the property.

microserviceName

String

The name of the microservice container of the property sheet.

newOwnerName

String

The name of the new owner.

notifierName

String

The email notifier name.

objectId

String

The object ID as returned by FindObjects.

path

String

Property path string.

pipelineName

String

The name of the pipeline container of the property sheet which owns the property.

pluginConfigurationName

String

The name of the plugin configuration container of the property sheet which owns the property.

pluginName

String

The name of a plugin.

procedureName

String

The name of a procedure.

processName

String

The name of a process.

processStepName

String

The name of a process step.

projectName

String

The name of a project.

propertySheetId

String

The primary key of the property sheet.

recursive

Boolean

The argument applies ownership changes of pipeline, release, and flowRuntime objects to associated child objects. When set to the default value, false, ownership changes are applied only to the selected object. If set to true, ownership changes are applied as follows: Pipeline and release: Changes are applied to stages, gates, tasks, associated flow and flow state objects, and common objects. Common objects are properties, email notifiers, event subscriptions, and formal parameters. flowRuntime: Changes are applied to flowRuntimeState, nested flowRuntime objects, and common objects. Common options are properties, email notifiers, event subscriptions.

releaseName

String

The name of the release container of the property sheet which owns the property.

reportName

String

The name of a report.

reportObjectTypeName

String

The name of a report object type.

repositoryName

String

The name of the repository container of the property sheet which owns the property.

resourceName

String

The name of a resource.

resourcePoolName

String

The name of the resource pool container of the property sheet which owns the property.

resourceTemplateName

String

The name of the resource template container of the property sheet which owns the property.

scheduleName

String

The name of a schedule.

scmSyncName

String

The name of the Scm Sync container of the property sheet which owns the property.

snapshotName

String

The name of the snapshot container of the property sheet which owns the property.

stageName

String

The name of the stage container of the property sheet which owns the property.

stateDefinitionName

String

The name of a workflow state definition.

stepName

String

The name of a procedure step.

taskName

String

The name of the task which owns property sheet.

transitionDefinitionName

String

The name of a workflow transition definition.

triggerName

String

The name of the trigger which owns property sheet.

userName

String

The name of a user.

widgetName

String

The name of a widget.

workflowDefinitionName

String

The name of a workflow definition.

workflowName

String

The name of the workflow container of the property sheet which owns the property.

workspaceName

String

The name of a workspace.

zoneName

String

The name of the zone container of the property sheet.

applicationName

String

The name of the application container of the property sheet that owns the property.

applicationTierName

String

The name of the application tier container of the property sheet that owns the property.

archiveConnectorName

String

The name of the archive connector of the property sheet that owns the property.

artifactName

String

The name of the artifact container of the property sheet that owns the property.

artifactVersionName

String

The name of the artifactVersion container of the property sheet that owns the property.

catalogItemRunId

String

The primary key of the CatalogItemRun container of the property sheet that owns the property.

catalogName

String

The name of the catalog of the property sheet that owns the property.

ciBuildDetailName

String

The name of the CI build detail of the property sheet that owns the property.

ciConfigurationName

String

The name of the CI Configuration.

clusterName

String

The name of the cluster which owns property sheet.

componentName

String

The name of the component container of the property sheet that owns the property.

configName

String

The name of the emailConfig container that owns the property.

credentialName

String

The name of the credential container of the property sheet that owns the property.

credentialProviderName

String

Unique name of the credential provider within the project.

dashboardName

String

The name of the dashboard of the property sheet that owns the property.

dataRetentionPolicyName

String

The name of the data retention policy of the property sheet that owns the property.

environmentName

String

The name of the environment container of the property sheet that owns the property.

environmentTemplateName

String

The name of the environment template container of the property sheet that owns the property.

environmentTemplateTierName

String

The name of the environment template tier container of the property sheet that owns the property.

environmentTierName

String

The name of the environment tier container of the property sheet that owns the property.

flowName

String

The name of the flow container of the property sheet that owns the property.

flowRuntimeId

String

The primary key or name of the flowRuntime container of the property sheet that owns the property.

flowRuntimeName

String

The name of the flow runtime container of the property sheet that owns the property.

flowRuntimeStateId

String

The primary key or name of the flowRuntimeState container of the property sheet that owns the property.

flowRuntimeStateName

String

The name of the flow state container of the property sheet that owns the property.

flowStateName

String

The name of the flow state container of the property sheet that owns the property.

flowTransitionName

String

The name of the flow transition container of the property sheet that owns the property.

gateType

String

The type of the gate which owns property sheet.

gatewayName

String

The name of the gateway container of the property sheet.

groupName

String

The name of the group container of the property sheet that owns the property.

jobId

String

The primary key or name of the job container of the property sheet that owns the property.

jobStepId

String

The primary key of the job-step container of the property sheet that owns the property.

kerberosKeytabName

String

The name of the kerberos keytab.

microserviceName

String

The name of the microservice container of the property sheet.

notifierName

String

The name of the notifier container of the property sheet that owns the property.

objectId

String

The object ID as returned by FindObjects.

objectType

String

The type of object protected by the access control.

path

String

Property path string.

personaName

String

The name of the persona.

pipelineName

String

The name of the pipeline container of the property sheet that owns the property.

pluginConfigurationName

String

The name of the plugin configuration container of the property sheet that owns the property.

pluginName

String

The name of the plugin container of the property sheet that owns the property.

procedureName

String

The name of the procedure container of the property sheet that owns the property.

processName

String

The name of the process, if the container is a process or process step.

processStepName

String

The name of the process step, if the container is a process step.

projectName

String

The name of the project container of the property sheet that owns the property.

propertySheetId

String

The primary key of the property sheet that owns the property.

releaseName

String

The name of the release container of the property sheet that owns the property.

reportName

String

The name of the report of the property sheet that owns the property.

reportObjectTypeName

String

The name of the report object type of the property sheet that owns the property.

repositoryName

String

The name of the repository container of the property sheet that owns the property.

resourceName

String

The name of the resource container of the property sheet that owns the property.

resourcePoolName

String

The name of the resource pool container of the property sheet that owns the property.

resourceTemplateName

String

The name of the resource template container of the property sheet that owns the property.

scheduleName

String

The name of the schedule container of the property sheet.

scmSyncName

String

The name of the SCM Sync container of the property sheet that owns the property.

searchFilterName

String

The name of the search filter container of the property sheet.

serviceAccountName

String

Retrieves the name of the service account container of the property sheet.

snapshotName

String

The name of the snapshot container of the property sheet that owns the property.

stageName

String

The name of the stage container of the property sheet that owns the property.

stateDefinitionName

String

The name of the state definition container of the property sheet that owns the property.

stateName

String

The name of the state container of the property sheet that owns the property.

stepName

String

The name of the step container of the property sheet that owns the property.

systemObjectName

String

The system object.

tagName

String

The name of the tag.

taskName

String

The name of the task which owns property sheet.

transitionDefinitionName

String

The name of the transition definition container of the property sheet that owns the property.

transitionName

String

The name of the transition container of the property sheet that owns the property.

triggerName

String

The name of the trigger which owns property sheet.

userName

String

The name of the user container of the property sheet that owns the property.

widgetName

String

The name of the widget of the property sheet that owns the property.

workflowDefinitionName

String

The name of the workflow definition container of the property sheet that owns the property.

workflowName

String

The name of the workflow container of the property sheet that owns the property.

workspaceName

String

The name of the workspace container of the property sheet.

zoneName

String

The name of the zone container of the property sheet.

applicationName

String

The name of the application container of the property sheet that owns the property.

applicationTierName

String

The name of the application tier container of the property sheet that owns the property.

archiveConnectorName

String

The name of the archive connector of the property sheet that owns the property.

artifactName

String

The name of the artifact container of the property sheet that owns the property.

artifactVersionName

String

The name of the artifactVersion container of the property sheet that owns the property.

catalogItemName

String

The Catalog Item name.

catalogItemRunId

String

The primary key of the CatalogItemRun container of the property sheet that owns the property.

catalogName

String

The name of the catalog of the property sheet that owns the property.

ciBuildDetailName

String

The name of the CI build detail of the property sheet that owns the property.

cloneName

String

New name to use for a cloned copy of an object.

cloneTaskGroup

String

The name of the group of task.

clusterName

String

The name of the cluster which owns property sheet.

componentName

String

The name of the component container of the property sheet that owns the property.

configName

String

The name of the emailConfig container that owns the property.

credentialName

String

The name of the credential container of the property sheet that owns the property.

credentialProviderName

String

The credential provider name.

dashboardName

String

The name of the dashboard of the property sheet that owns the property.

dataRetentionPolicyName

String

The name of the data retention policy of the property sheet that owns the property.

disableProjectTracking

Boolean

If set to true, when copying a project, even if the original project has change tracking enabled, make change tracking of the new copy of the project be disabled from its creation. If you don’t need to track changes to the new copy, this avoids the change tracking overhead that would otherwise slow down the copying operation, and also saves having to subsequently disable change tracking of the new copy of the project.

environmentName

String

The name of the environment container of the property sheet that owns the property.

environmentTemplateName

String

The name of the environment template container of the property sheet that owns the property.

environmentTemplateTierName

String

The name of the environment template tier container of the property sheet that owns the property.

environmentTierName

String

The name of the environment tier container of the property sheet that owns the property.

flowName

String

The name of the flow container of the property sheet that owns the property.

flowRuntimeId

String

The primary key or name of the flowRuntime container of the property sheet that owns the property.

flowRuntimeName

String

The name of the flow runtime container of the property sheet that owns the property.

flowRuntimeStateId

String

The primary key or name of the flowRuntimeState container of the property sheet that owns the property.

flowRuntimeStateName

String

The name of the flow state container of the property sheet that owns the property.

flowStateName

String

The name of the flow state container of the property sheet that owns the property.

flowTransitionName

String

The name of the flow transition container of the property sheet that owns the property.

gateType

String

The type of the gate which owns property sheet.

gatewayName

String

The name of the gateway container of the property sheet.

groupName

String

The name of the group container of the property sheet that owns the property.

jobId

String

The primary key or name of the job container of the property sheet that owns the property.

jobStepId

String

The primary key of the job-step container of the property sheet that owns the property.

linkNewPersona

Boolean

Set to 1 to associate users and groups to the cloned persona.

microserviceName

String

The name of the microservice container of the property sheet.

notifierName

String

The name of the notifier container of the property sheet that owns the property.

objectId

String

The object ID as returned by FindObjects.

path

String

Property path string.

personaName

String

The persona name.

pipelineName

String

The name of the pipeline container of the property sheet that owns the property.

pluginConfigurationName

String

The name of the plugin configuration container of the property sheet that owns the property.

pluginName

String

The name of the plugin container of the property sheet that owns the property.

procedureName

String

The name of the procedure container of the property sheet that owns the property.

processName

String

The name of the process, if the container is a process or process step.

processStepName

String

The name of the process step, if the container is a process step.

projectName

String

The name of the project container of the property sheet that owns the property.

propertySheetId

String

The primary key of the property sheet that owns the property.

providerName

String

The unique name of the directory provider.

reducedDetailChangeHistory

Boolean

Set to 0 or false to prevent copying of a large project that has change tracking enabled from automatically reducing the level of detail that it tracks for the change history of the copy — this will make the copy operation take longer and put more load on the database, but will allow the Change History feature to still show the full detail of entities owned by the copy of the project that were created by the copy operation.

releaseName

String

The name of the release container of the property sheet that owns the property.

reportName

String

The name of the report of the property sheet that owns the property.

reportObjectTypeName

String

The name of the report object type of the property sheet that owns the property.

repositoryName

String

The name of the repository container of the property sheet that owns the property.

resourceName

String

The name of the resource container of the property sheet that owns the property.

resourcePoolName

String

The name of the resource pool container of the property sheet that owns the property.

resourceTemplateName

String

The name of the resource template container of the property sheet that owns the property.

scheduleName

String

The name of the schedule container of the property sheet.

scmSyncName

String

The name of the SCM Sync container of the property sheet that owns the property.

searchFilterName

String

The name of the search filter container of the property sheet.

serviceAccountName

String

Retrieves the name of the service account container of the property sheet.

snapshotName

String

The name of the snapshot container of the property sheet that owns the property.

stageName

String

The name of the stage container of the property sheet that owns the property.

stateDefinitionName

String

The name of the state definition container of the property sheet that owns the property.

stateName

String

The name of the state container of the property sheet that owns the property.

stepName

String

The name of the step container of the property sheet that owns the property.

systemObjectName

String

The system object.

taskName

String

The name of the task which owns property sheet.

transitionDefinitionName

String

The name of the transition definition container of the property sheet that owns the property.

transitionName

String

The name of the transition container of the property sheet that owns the property.

triggerName

String

The name of the trigger which owns property sheet.

unlinkOriginalPersona

Boolean

Set to 1 to disassociate users and groups from the original or the persona being cloned.

userName

String

The name of the user container of the property sheet that owns the property.

widgetName

String

The name of the widget of the property sheet that owns the property.

workflowDefinitionName

String

The name of the workflow definition container of the property sheet that owns the property.

workflowName

String

The name of the workflow container of the property sheet that owns the property.

workspaceName

String

The name of the workspace container of the property sheet.

zoneName

String

The name of the zone container of the property sheet.

objectType

String

The type of object to query for. (Required)

filters

Filter array

A list of zero or more filter criteria definitions used to define objects to find.

maxIds

Integer

The maximum number of object IDs to return.

viewName

String

The name of the view.

objectType

String

The type of object to delete. (Required)

filters

Filter array

A list of zero or more filter criteria definitions used to define objects to find.

maxIds

Integer

The maximum number of object IDs to return.

sorts

Sort array

Sort specifications.

objectName

String

Name of the object to describe. (Required)

objectType

String

Name of the object type to get DSL structure.

includeChildrenWithFileRef

Boolean

Include in response types that have properties replaced with file reference even if they are always included in parent DSL.

topLevelOnly

Boolean

If True and no entityType provided return the list of top-level objects only.If entityType provided return the type details with top level children.