BuildMaster Documentation

Native API Methods

These methods are callable through JSON, SOAP, or SQL. Note that the Native API must be explicitly enabled by setting an API key under Administration > All Settings. Because this is a low-level API, specific user or task authorization is not performed and, if needed, may be done through the various Security_ methods.

This API endpoint should be avoided if there is an alternate API endpoint available, as those are much easier to use and will likely not change.

For security and simplicity, these endpoints require that an API Key is created and passed into each request.

Method Listing

This listing was generated from BuildMaster 5.5, and may be different in earlier releases. To see the api methods for your specific version, visit /reference/api in your BuildMaster installation.

Input Output
AdminEdit_PurgeArtifact
Purges an artifact from the specified build.
Application_Id (Int32)
Release_Number (String)
Build_Number (String)
Artifact_Name (String)
none
AdminEdit_PurgeBuild
Purges an entire build and all associated data from the system.
Application_Id (Int32)
Release_Number (String)
Build_Number (String)
none
AdminEdit_UpdateBuildStatus
Updates the status of a build.
Application_Id (Int32)
Release_Number (String)
Build_Number (String)
BuildStatus_Name (String)
none
AdminEdit_UpdateExecutionStatus
Updates the status of an execution.
Execution_Id (Int32)
ExecutionStatus_Code (String)
none
AdminEdit_UpdatePromotionStatus
Updates the status of a promotion.
Promotion_Id (Int32)
PromotionStatus_Name (String)
none
AdminEdit_UpdateReleaseStatus
Updates the status of a release.
Application_Id (Int32)
Release_Number (String)
ReleaseStatus_Name (String)
none
ApplicationGroups_CreateOrUpdateApplicationGroup
Creates or updates a new application group
ApplicationGroup_Id (Int32)
ApplicationGroup_Name (String)
ApplicationGroup_Description (String)
Parent_ApplicationGroup_Id (Int32)
ApplicationGroup_Id
ApplicationGroups_DeleteApplicationGroup
Deletes an application group
ApplicationGroup_Id (Int32) none
ApplicationGroups_GetApplicationGroup
Gets an application group by ID.
ApplicationGroup_Id (Int32) DataRow (ApplicationGroups)
ApplicationGroups_GetApplicationGroups
Gets all the application groups
none DataTable (ApplicationGroups)
ApplicationGroups_GetOrCreateApplicationGroup
Gets or creates a new application group using the name
ApplicationGroup_Name (String)
ApplicationGroup_Id (Int32)
ApplicationGroup_Id
Applications_AddImportedDeployable
Adds an imported deployable to an application
Deployable_Id (Int32)
Application_Id (Int32)
none
Applications_CreateApplication
Creates a new application.
Application_Name (String)
ReleaseNumber_Scheme_Name (String)
IssueTracking_Provider_Id (Int32)
BuildNumber_Scheme_Name (String)
AllowMultipleActiveReleases_Indicator (YNIndicator)
AllowMultipleActiveBuilds_Indicator (YNIndicator)
ApplicationGroup_Id (Int32)
Application_Id (Int32)
Application_Id
Applications_CreateOrUpdateDeployable
Creates a deployable for a specified application, or updates an existing one
Deployable_Id (Int32)
Application_Id (Int32)
Deployable_Name (String)
Deployable_Id
Applications_DeactivateApplication
Deactivates an application, removing it from menu options but preserves data.
Application_Id (Int32) none
Applications_DeleteImportedDeployable
Deletes an existing imported deployable relation, but does not delete the deployable from the host application
Deployable_Id (Int32)
Application_Id (Int32)
none
Applications_EditApplication
Edits an existing application.
Application_Id (Int32)
Application_Name (String)
Application_Description (String)
ApplicationGroup_Id (Int32)
AllowMultipleActiveReleases_Indicator (YNIndicator)
AllowMultipleActiveBuilds_Indicator (YNIndicator)
VariableSupport_Code (String)
ReleaseNumber_Scheme_Name (String)
BuildNumber_Scheme_Name (String)
none
Applications_FindDeployables
Searches for deployables in the system.
SearchTerm_Text (String)
Max_Count (Int32)
DataTable (Deployables_Extended)
Applications_GetApplication
Gets the details of an application along with the associated deployables
Application_Id (Int32) DataSet (Applications_Extended, Deployables_Extended)
Applications_GetApplications
Gets the specified number of applications in the system, or all if null is passed in
Application_Count (Int32)
IncludeInactive_Indicator (YNIndicator)
DataTable (Applications_Extended)
Applications_GetDependentApplications
Gets all applications with imported deployables from a specified application
Application_Id (Int32) DataTable (Applications_Extended)
Applications_GetDeployable
Gets the specified deployable
Deployable_Id (Int32) DataTable (Deployables_Extended)
Applications_GetDeployableDependencies
Gets a set of dependencies for the deployables in a given application or a specific deployable if one is specified
Application_Id (Int32)
Deployable_Id (Int32)
DataTable (DeployableDependencies)
Applications_GetDeployables
Gets the deployables for a specific application or for all applications.
Application_Id (Int32) DataTable (Deployables_Extended)
Applications_GetImportedDeployables
Gets a set a imported deployables for a specified application
Application_Id (Int32) DataTable (DeployablesImported_Extended)
Applications_GetLatestEnvironmentExecutions
Gets a view of all the latest executions grouped by application and environment, optionally filtered by application or application group.
Application_Id (Int32)
ApplicationGroup_Id (Int32)
DataTable (Applications_LatestEnvironmentExecutions)
Applications_GetSpecifiedApplications
Gets only the active applications in the specified CSV string.
ApplicationIds_Csv (String) DataTable (Applications_Slim)
Applications_PurgeApplicationData
Purges an entire application and all associated data from the system.
Application_Id (Int32) none
Applications_PurgeDeployableData
Purges a deployable and all its associations from the system.
Deployable_Id (Int32) none
Applications_ReactivateApplication
Reactivates an application that has been deactivated.
Application_Id (Int32) none
Applications_SearchApplications
Searches for applications by application name and group name that contain the search term.
SearchTerm_Text (String) DataTable (Applications_Slim)
Applications_SetDeployableDependencies
Sets the dependency relationships between the specified deployable and its dependents
Deployable_Id (Int32)
DependsOn_Deployables_Csv (String)
none
Applications_SetIssueTracker
Sets the issue tracking provider of a specified application.
Application_Id (Int32)
IssueTracking_Provider_Id (Int32)
IssueTracking_CategoryIdList_Text (String)
IssueTracking_Filter_Configuration (String)
IssueTracking_AllowBuildMasterIssues_Indicator (YNIndicator)
none
Artifacts_CreateOrReplaceArtifact
Creates a reference to an artifact in the artifact library.
Application_Id (Int32)
Release_Number (String)
Build_Number (String)
Deployable_Id (Int32)
Artifact_Name (String)
Execution_Id (Int32)
Artifact_Path (String)
none
Artifacts_GetArtifact
Gets an artifact based on the specified criteria.
Application_Id (Int32)
Release_Number (String)
Build_Number (String)
Artifact_Name (String)
DataRow (BuildArtifacts_Extended)
Artifacts_GetArtifacts
Gets a set of artifacts based on the specified criteria.
Application_Id (Int32)
Release_Number (String)
Build_Number (String)
Deployable_Id (Int32)
Artifact_Count (Int32)
DataTable (BuildArtifacts_Extended)
Artifacts_GetArtifactsByBuildStatus
Gets a set of artifacts that are associated with a specified build status, optionally filtered by application and release.
Application_Id (Int32)
Release_Number (String)
BuildStatus_Name (String)
DataTable (BuildArtifacts_Slim)
BuildOutputs_AddOutput
Adds a build output report to a specified build execution
Execution_Id (Int32)
Output_Name (String)
Output_Bytes (Byte[])
OutputType_Code (String)
none
BuildOutputs_GetOutput
Gets the build output report for a specified build and sequence number
Execution_Id (Int32)
Output_Sequence (Int32)
DataRow (BuildOutputs_Extended)
BuildOutputs_GetOutputs
Gets the build output reports for a specified build
Execution_Id (Int32) DataTable (BuildOutputs_Extended)
Builds_CreateBuild
Creates a new build of an application.
Application_Id (Int32)
Release_Number (String)
Build_Number (String)
BuildImporter_Configuration (String)
none
Builds_GetBuild
Gets the details for a specified build.
Application_Id (Int32)
Release_Number (String)
Build_Number (String)
DataRow (Builds_Extended)
Builds_GetBuildById
Gets the details for a specified build by ID.
Build_Id (Int32) DataRow (Builds_Extended)
Builds_GetBuilds
Gets the details for all builds that match the specified criteria.
Application_Id (Int32)
Release_Number (String)
BuildStatus_Name (String)
Build_Count (Int32)
DataTable (Builds_Extended)
Builds_GetExecution
Gets all details regarding a specific build execution
Execution_Id (Int32) DataRow (BuildExecutions_Extended)
Builds_GetExecutionExtended
Gets all details regarding a specific build execution.
Execution_Id (Int32) DataSet (BuildExecutions_Extended, BuildExecution_DeploymentPlans, BuildExecution_DeploymentPlanActionGroups, BuildExecution_ActionGroupActions, BuildExecution_ActionGroupActionLogEntries)
Builds_GetExecutions
Gets all the build executions for the specified build
Application_Id (Int32)
Release_Number (String)
Build_Number (String)
PipelineStage_Name (String)
Execution_Count (Int32)
DataTable (BuildExecutions_Extended)
Builds_GetExecutionsByServer
Gets recent build executions for the specified server.
Server_Id (Int32)
Execution_Count (Int32)
DataTable (BuildExecutions_Extended)
Builds_GetExecutionsInProgress
Gets all executions in the executing state optionally filtered by application.
Application_Id (Int32) DataTable (BuildExecutions_Extended)
Builds_GetPromotion
Gets a build promotion.
Promotion_Id (Int32) DataRow (BuildPromotions_Extended)
Builds_GetPromotions
Gets all of the promotions that have occurred.
Application_Id (Int32)
Release_Number (String)
Build_Number (String)
DataTable (BuildPromotions_Extended)
Builds_PromoteBuild
Promotes a build to to a pipeline stage.
Application_Id (Int32)
Release_Number (String)
Build_Number (String)
Comments_Text (String)
ForcePromotion_Indicator (YNIndicator)
PromoteTo_PipelineStage_Name (String)
SetFurthestStage_Indicator (YNIndicator)
Promotion_Id (Int32)
Promotion_Id
Builds_PurgeBuildData
Purges an entire build and all associated data from the system.
Application_Id (Int32)
Release_Number (String)
Build_Number (String)
none
Builds_RejectBuild
Rejects the specified build.
Application_Id (Int32)
Release_Number (String)
Build_Number (String)
Rejection_Notes (String)
none
Builds_SetBuildNumber
Sets the build number of a build.
Build_Id (Int32)
Build_Number (String)
none
BuildSchedules_CreateOrUpdateRecurring
Creates a recurring build based on the specified parameters, or updates an existing schedule if one with the given ID already exists.
Schedule_Id (Int32)
Schedule_Name (String)
Application_Id (Int32)
StartTime_Minutes (Int32)
EndTime_Minutes (Int32)
DailyInterval_Minutes (Int32)
Recurrence_Type (String)
RecurrenceFrequency_Value (Int32)
RecurrenceWeeklyDay_Mask (String)
RecurrenceMonthlyDay_Value (Int32)
RecurrenceMonthlyRelativity_Type (String)
RecurrenceMonthlyRelativityDay_Type (String)
RecurrenceMonthlyRelativityWeek_Type (String)
RecurrenceMonthlyRelativityWeekDay_Value (Int32)
ReleaseFilter_ReleaseType_Code (String)
ReleaseFilter_Pipeline_Id (Int32)
BuildImporter_Configuration (String)
Active_Indicator (YNIndicator)
Schedule_Id
BuildSchedules_CreateOrUpdateSchedule
Creates a scheduled build based on the specified parameters, or updates an existing scheduled build if one with the given ID already exists.
Schedule_Id (Int32)
Schedule_Name (String)
Application_Id (Int32)
Active_Indicator (YNIndicator)
Schedule_Type (String)
StartTime_Minutes (Int32)
EndTime_Minutes (Int32)
DailyInterval_Minutes (Int32)
Recurrence_Type (String)
RecurrenceFrequency_Value (Int32)
RecurrenceWeeklyDay_Mask (String)
RecurrenceMonthlyDay_Value (Int32)
RecurrenceMonthlyRelativity_Type (String)
RecurrenceMonthlyRelativityDay_Type (String)
RecurrenceMonthlyRelativityWeek_Type (String)
RecurrenceMonthlyRelativityWeekDay_Value (Int32)
Url_AllowedIP_CSV (String)
Url_Username_Text (String)
Url_Password_Text (String)
SourceControl_Path_Name (String)
SourceControl_Provider_Id (Int32)
SourceControl_QuietPeriod_Minutes (Int32)
ReleaseFilter_ReleaseType_Code (String)
ReleaseFilter_Pipeline_Id (Int32)
Schedule_Id
BuildSchedules_CreateOrUpdateSCMTriggered
Creates a source control triggered automated build based on the specified parameters, or updates an existing one if one with a given ID already exists.
Schedule_Id (Int32)
Schedule_Name (String)
Application_Id (Int32)
SourceControl_Path_Name (String)
SourceControl_Provider_Id (Int32)
SourceControl_QuietPeriod_Minutes (Int32)
ReleaseFilter_ReleaseType_Code (String)
ReleaseFilter_Pipeline_Id (Int32)
Active_Indicator (YNIndicator)
Schedule_Id
BuildSchedules_CreateOrUpdateURLTriggered
Creates a URL-triggered build based on the specified parameters, or updates an existing schedule if one with the given ID already exists.
Schedule_Id (Int32)
Schedule_Name (String)
Application_Id (Int32)
Url_AllowedIP_CSV (String)
Url_Username_Text (String)
Url_Password_Text (String)
ReleaseFilter_ReleaseType_Code (String)
ReleaseFilter_Pipeline_Id (Int32)
BuildImporter_Configuration (String)
Active_Indicator (YNIndicator)
Schedule_Id
BuildSchedules_DeleteBuildSchedule
Deletes the specified build schedule
Schedule_Id (Int32) none
BuildSchedules_GetBuildSchedule
Gets the specified build schedule
Schedule_Id (Int32) DataSet (BuildSchedules_Extended, BuildScheduleVariableDefinitions_Extended)
BuildSchedules_GetBuildSchedules
Gets a set of builds schedules for the specified application and active indicator, or all if null is supplied
Application_Id (Int32)
Active_Indicator (YNIndicator)
DataTable (BuildSchedules_Extended)
BuildSchedules_SetVariableDefinition
Updates a variable definition to use with a scheduled build
Schedule_Id (Int32)
VariableDeclaration_Id (Int32)
Value_Text (String)
none
BuildTestResults_GetAllGroups
Gets all of the test result groups in the system.
none DataTable (BuildTestResults_AllGroups)
BuildTestResults_GetTestGroupResults
Gets the unit test results for a specified build execution.
Execution_Id (Int32) DataTable (BuildTestResults_TestGroupResults)
BuildTestResults_GetTestGroupResultsForBuild
Gets the unit test results for the specified build.
Application_Id (Int32)
Release_Number (String)
Build_Number (String)
DataTable (BuildTestResults_TestGroupResults)
BuildTestResults_GetTestHistory
Gets this history of a test by its name, and optionally filtered by test group and application.
Test_Name (String)
Group_Name (String)
Application_Id (Int32)
TestStatus_Code (String)
Row_Count (Int32)
DataTable (BuildTestResults_Extended)
BuildTestResults_GetTestLog
Gets the results of a specific unit test
Execution_Id (Int32)
Group_Name (String)
Test_Sequence (Int32)
DataTable (BuildTestResults_Extended)
BuildTestResults_GetTestResults
Gets the build test results based on the specified criteria.
Execution_Id (Int32)
Group_Name (String)
DataTable (BuildTestResults_Extended)
BuildTestResults_RecordTestResult
Logs the result of an individual unit test.
Execution_Id (Int32)
Group_Name (String)
Test_Name (String)
TestStatus_Code (String)
TestResult_Text (String)
TestStarted_Date (DateTime)
TestEnded_Date (DateTime)
none
ChangeControlPerformances_GetReleaseSummary
Gets a summary of the change control performances for a specified change control.
ChangeControl_Id (Int32) DataTable (ChangeControlPerformances_ReleaseSummary)
ChangeControls_CreateOrUpdateChangeControl
Creates a new change control, or updates an existing one.
ChangeControl_Id (Int32)
ChangeControl_Name (String)
Application_Id (Int32)
Release_Number (String)
Group_Name (String)
Description_Text (String)
Principal_Name (String)
PrincipalType_Code (String)
PerformanceType_Code (String)
Active_Indicator (YNIndicator)
Environments_Csv (String)
ChangeControl_Id
ChangeControls_DeleteChangeControl
Deletes the specified change control
ChangeControl_Id (Int32) none
ChangeControls_GetChangeControl
Gets the details of a specified change control.
ChangeControl_Id (Int32) DataSet (ChangeControls_Extended, ChangeControlEnvironments_Extended)
ChangeControls_GetChangeControlPerformances
Gets a list of change control performances for a specified change control or all change controls if none is specified.
Application_Id (Int32)
ChangeControl_Id (Int32)
Release_Number (String)
IncludeInactive_Indicator (YNIndicator)
Environment_Id (Int32)
Row_Count (Int32)
DataTable (ChangeControlPerformances_Extended)
ChangeControls_GetChangeControls
Gets a list of change controls based on the specified criteria.
Application_Id (Int32)
Release_Number (String)
IncludeInactive_Indicator (YNIndicator)
ChangeControl_Count (Int32)
DataSet (ChangeControls_Extended, ChangeControlEnvironments_Extended)
ChangeControls_PerformChangeControl
Adds a change control performance for a specified environment.
ChangeControl_Id (Int32)
Environment_Id (Int32)
Notes_Text (String)
none
Configuration_GetConfiguration
Gets the a complete list of BuildMaster configuration settings.
none DataTable (Configuration)
Configuration_GetValue
Gets the specified BuildMaster configuration value.
Scope_Name (String)
Key_Name (String)
Value_Text (String)
Value_Text
Configuration_SetValue
Sets a BuildMaster configuration value.
Scope_Name (String)
Key_Name (String)
Value_Text (String)
none
ConfigurationFiles_CreateConfigurationFile
Creates a configuration file in the system.
Application_Id (Int32)
Deployable_Id (Int32)
FilePath_Text (String)
ConfigurationFile_Name (String)
Description_Text (String)
ConfigurationFile_Id (Int32)
ConfigurationFile_Id
ConfigurationFiles_CreateConfigurationFileInstance
Creates a new instance of a configuration file.
ConfigurationFile_Id (Int32)
Instance_Name (String)
Environment_Id (Int32)
Template_Indicator (YNIndicator)
Template_Instance_Name (String)
TransformType_Code (String)
none
ConfigurationFiles_CreateConfigurationFileVersions
Creates new configuration file versions for each instance specified in the ConfigurationFiles_Xml for the given configuration file.
ConfigurationFile_Id (Int32)
ConfigurationFiles_Xml (String)
ReleaseNumbers_Csv (String)
none
ConfigurationFiles_DeployConfigurationFile
Saves the result of a deployed configuration file (this will not physically deploy the configuration file).
Execution_Id (Int32)
ConfigurationFile_Id (Int32)
Instance_Name (String)
Version_Number (Int32)
Server_Id (Int32)
DeployedTo_Path (String)
DeployedBy_User_Name (String)
ConfigurationFileDeployment_Id (Int32)
ConfigurationFileDeployment_Id
ConfigurationFiles_GetConfigurationFile
Gets a configuration file and all of its instances.
ConfigurationFile_Id (Int32)
IncludeInactiveInstances_Indicator (YNIndicator)
DataSet (ConfigurationFiles_Extended, ConfigurationFileInstances_Extended, ConfigurationFileVersions_Combined, ConfigurationFileVersions_ModifiedInstances)
ConfigurationFiles_GetConfigurationFileDeployments
Gets a list of all configuration file deployments based on the specified criteria.
Application_Id (Int32)
ConfigurationFile_Id (Int32)
Deployable_Id (Int32)
Instance_Name (String)
Server_Id (Int32)
File_Count (Int32)
DataTable (ConfigurationFileDeployments_Extended)
ConfigurationFiles_GetConfigurationFileInstances
Gets a list of all configuration file instances that match the specified criteria.
Application_Id (Int32)
Deployable_Id (Int32)
Active_Indicator (YNIndicator)
DataTable (ConfigurationFileInstances_Extended)
ConfigurationFiles_GetConfigurationFiles
Gets all configuration files that match the specified criteria.
Application_Id (Int32)
Deployable_Id (Int32)
IncludeInactive_Indicator (YNIndicator)
IncludeInstances_Indicator (YNIndicator)
IncludeVersions_Indicator (YNIndicator)
DataSet (ConfigurationFiles_Extended, ConfigurationFileInstances_Extended, ConfigurationFileVersions_Combined, ConfigurationFileVersions_ModifiedInstances)
ConfigurationFiles_GetConfigurationFileVersion
Gets a list of configuration file versions for a specified configuration file.
ConfigurationFile_Id (Int32)
Instance_Name (String)
Version_Number (Int32)
DataTable (ConfigurationFileVersions_Extended)
ConfigurationFiles_PurgeConfigurationFile
Purges a configuration file, including all previous versions of all instances and deployment history.
ConfigurationFile_Id (Int32) none
ConfigurationFiles_PurgeConfigurationFileInstance
Purges a configuration file instance, including all previous versions and deployment history.
ConfigurationFile_Id (Int32)
Instance_Name (String)
UnlinkTemplate_Indicator (YNIndicator)
none
ConfigurationFiles_UpdateConfigurationFile
Updates metadata for an existing configuration file.
ConfigurationFile_Id (Int32)
Active_Indicator (YNIndicator)
ConfigurationFile_Name (String)
FilePath_Text (String)
Description_Text (String)
Deployable_Id (Int32)
none
ConfigurationFiles_UpdateConfigurationFileInstance
Updates metadata for an existing configuration file instance.
ConfigurationFile_Id (Int32)
Instance_Name (String)
Environment_Id (Int32)
Active_Indicator (YNIndicator)
Template_Instance_Name (String)
TransformType_Code (String)
none
Credentials_CreateOrUpdateCredential
Creates a new credential or updates an existing one.
Credential_Name (String)
Environment_Id (Int32)
CredentialType_Name (String)
Configuration_Xml (String)
AllowFunctionAccess_Indicator (YNIndicator)
Credential_Id (Int32)
Credential_Id
Credentials_DeleteCredential
Gets the specified credential.
Credential_Id (Int32) DataRow (Credentials_Extended)
Credentials_GetCredential
Gets the specified credential.
Credential_Id (Int32) DataRow (Credentials_Extended)
Credentials_GetCredentialByName
Gets the specified credential by its qualified name.
CredentialType_Name (String)
Credential_Name (String)
DataRow (Credentials_Extended)
Credentials_GetCredentials
Gets all credentials in the system.
none DataTable (Credentials_Extended)
DatabaseChangeScripts_CreateOrUpdateChangeScript
Creates or edits a database change script.
Application_Id (Int32)
Release_Number (String)
Deployable_Id (Int32)
Script_Name (String)
Script_Text (String)
Active_Indicator (YNIndicator)
Script_Id (Int32)
Script_Id
DatabaseChangeScripts_DeleteChangeScript
Deletes a database change script.
Script_Id (Int32) none
DatabaseChangeScripts_GetChangeScript
Gets the specified database change script.
Script_Id (Int32) DataRow (DatabaseChangeScripts_Extended)
DatabaseChangeScripts_GetChangeScripts
Gets all the database change scripts that match the specified criteria.
Application_Id (Int32)
Release_Number (String)
IncludeInactive_Indicator (YNIndicator)
DatabaseChangeScript_Count (Int32)
DataTable (DatabaseChangeScripts_Extended)
DatabaseChangeScripts_GetExecution
Gets a database change script execution.
Execution_Id (Int32) DataRow (DatabaseChangeScriptExecutions_Extended)
DatabaseConnections_CreateOrUpdateConnection
Creates a new database connection or updates an existing one.
DatabaseConnection_Name (String)
DatabaseConnection_Description (String)
DatabaseConnection_Configuration (String)
ExecuteOn_Server_Id (Int32)
Application_Id (Int32)
Environment_Id (Int32)
DatabaseConnection_Id (Int32)
DatabaseConnection_Id
DatabaseConnections_DeleteConnection
Deletes a database connection.
DatabaseConnection_Id (Int32) none
DatabaseConnections_GetConnection
Gets a database connection.
DatabaseConnection_Id (Int32) DataRow (DatabaseConnections_Extended)
DatabaseConnections_GetConnections
Gets database connections, optionally filtered by application and environment.
Application_Id (Int32)
Environment_Id (Int32)
DataTable (DatabaseConnections_Extended)
Environments_CreateOrUpdateEnvironment
Creates a new environment or updates an existing one
Environment_Name (String)
ServerIds_Csv (String)
Parent_Environment_Id (Int32)
Display_Sequence (Int32)
Environment_Id (Int32)
Environment_Id
Environments_DeleteEnvironment
Soft deletes an environment
Environment_Id (Int32) none
Environments_GetEnvironment
Gets an environment.
Environment_Id (Int32) DataSet (Environments_Extended, Servers)
Environments_GetEnvironments
Gets all environments.
IncludeInactive_Indicator (YNIndicator) DataTable (Environments_Extended)
Environments_GetEnvironmentsAndServers
Gets the a dataset containing all environments, all environment/server relations, and servers
IncludeInactive_Environments_Indicator (YNIndicator)
IncludeInactive_Servers_Indicator (YNIndicator)
DataSet (Environments_Extended, EnvironmentServers_Extended, Servers)
Environments_ResequenceEnvironment
Resequences the specified environment by placing it where another environment is sequenced
Environment_Id (Int32)
New_Environment_Sequence (Int32)
none
Environments_UndeleteEnvironment
Undeletes the specified environment
Environment_Id (Int32) none
EventListeners_CreateOrUpdateEventListener
Creates or updates an event listener.
EventListener_Description (String)
EventListener_Configuration (String)
Owner_User_Name (String)
Active_Indicator (YNIndicator)
EventCodeList_Csv (String)
ApplicationIdList_Csv (String)
ApplicationGroupIdList_Csv (String)
PipelineStageNameList_Csv (String)
EventListener_Id (Int32)
EventListener_Id
EventListeners_DeleteEventListener
Deletes an event listener.
EventListener_Id (Int32) none
EventListeners_GetEventListener
Gets a EventListener and a list of event codes that the EventListener is subscribed to.
EventListener_Id (Int32) DataSet (EventListeners, EventListenerApplications, EventListenerApplicationGroups, EventListenerStages, EventListenerEvents)
EventListeners_GetEventListeners
Gets a list of event listeners for the specified user, or all users if no user is specified.
Owner_User_Name (String) DataSet (EventListeners, EventListenerApplications, EventListenerApplicationGroups, EventListenerStages, EventListenerEvents)
Events_GetEventOccurrence
Get a specific event occurrence along with its event details.
EventOccurence_Id (Int32) DataSet (EventOccurences_Extended, EventOccurenceDetails)
Events_GetEventOccurrences
Gets all the event occurrences in the system for a specific application, or all applications, limited to a specified count if provided.
Application_Id (Int32)
Event_Count (Int32)
After_EventOccurence_Id (Int32)
DataTable (EventOccurences_Extended)
Executions_GetManualExecution
Gets a manual execution.
Execution_Id (Int32) DataRow (ManualExecutions_Extended)
ExtensionConfiguration_DeleteConfiguration
Deletes an extension configuration
ExtensionConfiguration_Id (Int32) none
ExtensionConfiguration_GetConfiguration
Gets the details of an extension configurer for extension with the specified name
QualifiedType_Name (String)
Profile_Name (String)
DataTable (ExtensionConfigurations)
ExtensionConfiguration_GetConfigurationById
Gets the details of an extension configurer for extension with the specified ID
ExtensionConfiguration_Id (Int32) DataRow (ExtensionConfigurations)
ExtensionConfiguration_GetConfigurations
Gets the details for all extension configurers in the system, or a specific one if specified
QualifiedType_Name (String) DataTable (ExtensionConfigurations)
ExtensionConfiguration_SaveConfiguration
Creates an extension configurer in the system, or updates an existing one
ExtensionConfiguration_Id (Int32)
QualifiedType_Name (String)
Profile_Name (String)
Extension_Configuration (String)
Default_Indicator (YNIndicator)
ExtensionConfiguration_Id
Infrastructure_GetInfrastructure
Gets all of the infrastructure; this includes servers, environments, and roles.
none DataSet (Servers, Environments_Extended, ServerRoles_Extended, EnvironmentServers_Extended, ServerRoleServers, Variables)
Issues_CloseIssue
Closes a BuildMaster issue.
Application_Id (Int32)
Issue_Id (Int32)
Build_Number (String)
none
Issues_CreateIssue
Creates an issue for a release of an application.
Application_Id (Int32)
Release_Number (String)
Type_Text (String)
Title_Text (String)
Description_Text (String)
Closed_Indicator (YNIndicator)
Build_Number (String)
CreatedBy_User_Name (String)
CreatedOn_Date (DateTime)
IssueTracker_IssueId_Text (String)
IssueTracker_IssueStatus_Text (String)
IssueTracker_LastSync_Date (DateTime)
IssueTracker_IssueUrl_Text (String)
Issue_Id (Int32)
Issue_Id
Issues_DeleteIssue
Deletes an issue.
Application_Id (Int32)
Issue_Id (Int32)
none
Issues_GetIssue
Gets the specified.
Application_Id (Int32)
Issue_Id (Int32)
DataRow (Issues_Extended)
Issues_GetIssues
Gets the issues for an application, optionally filtered by release or build.
Application_Id (Int32)
Release_Number (String)
Build_Number (String)
DataTable (Issues_Extended)
Issues_GetIssueTypes
Gets a list of distinct issue types that have been synchronized by the system.
none DataTable (Issues_Types)
Issues_ReopenIssue
Re-opens a BuildMaster issue.
Application_Id (Int32)
Issue_Id (Int32)
Build_Number (String)
none
Issues_UpdateIssue
Updates one or more properties of an issue.
Application_Id (Int32)
Issue_Id (Int32)
Release_Number (String)
Type_Text (String)
Title_Text (String)
Description_Text (String)
Closed_Indicator (YNIndicator)
IssueTracker_IssueStatus_Text (String)
IssueTracker_IssueUrl_Text (String)
IssueTracker_LastSync_Date (DateTime)
OpenedOn_Original_Build_Number (String)
ClosedOn_Original_Build_Number (String)
none
LegacyExecutions_SetVariableValue
Creates, updates, or deletes an execution time variable value.
BuildExecution_ActionGroupAction_Id (Int32)
Variable_Name (String)
Value_Text (String)
none
LogMessages_DeleteMessages
Deletes one or all message from the error log
LogMessage_Id (Int32) none
LogMessages_GetMessage
Gets a specified message from the error log
LogMessage_Id (Int32) DataRow (LogMessages_Extended)
LogMessages_GetMessages
Gets the messages from the error log that match the specified criteria
Row_Count (Int32)
Message_Level (Int32)
Category_Name (String)
Application_Id (Int32)
Schedule_Id (Int32)
Requirement_Id (Int32)
Provider_Id (Int32)
EventListener_Id (Int32)
Server_Id (Int32)
DataTable (LogMessages_Extended)
Notifiers_CreateOrUpdateNotifier
Creates a new notifier, or updates an existing one
Notifier_Id (Int32)
Notifier_Name (String)
Notifier_Description (String)
Notifier_Configuration (String)
Owner_User_Name (String)
Active_Indicator (YNIndicator)
EventCodeList_Csv (String)
none
Notifiers_DeleteNotifier
Deletes a notifier from the system
Notifier_Id (Int32) none
Notifiers_GetNotifier
Gets a notifier and a list of event codes that the notifier is subscribed to
Notifier_Id (Int32) DataSet (Notifiers, NotifierEventCodes)
Notifiers_GetNotifiers
Gets a list of notifiers for the specified user, or all users if no user is specified
Owner_User_Name (String) DataTable (Notifiers)
Pipelines_CreatePipeline
Creates a new pipeline.
Pipeline_Name (String)
Pipeline_Configuration (String)
Active_Indicator (YNIndicator)
Application_Id (Int32)
Pipeline_Color (String)
Pipeline_Id (Int32)
Pipeline_Id
Pipelines_DeletePipeline
Deletes a pipeline.
Pipeline_Id (Int32) none
Pipelines_GetPipeline
Returns the specified pipeline.
Pipeline_Id (Int32) DataRow (Pipelines)
Pipelines_GetPipelines
Returns the pipelines in the system, optionally filtered by application.
Application_Id (Int32) DataTable (Pipelines)
Pipelines_UpdatePipeline
Updates a pipeline.
Pipeline_Id (Int32)
Pipeline_Name (String)
Pipeline_Configuration (String)
Active_Indicator (YNIndicator)
Pipeline_Color (String)
none
Plans_ChangeActionGroup
Moves an action into a different action group.
DeploymentPlanActionGroup_Id (Int32)
Action_Sequence (Int32)
New_DeploymentPlanActionGroup_Id (Int32)
New_Action_Sequence (Int32)
none
Plans_ChangeActionGroupDeploymentPlan
Moves a plan action group to the final position of a different deployment plan.
DeploymentPlanActionGroup_Id (Int32)
New_DeploymentPlan_Id (Int32)
none
Plans_CloneDeploymentPlans
Clones one or more deployment plans
DeploymentPlanCloneData_Xml (String)
NewDeploymentPlanIdsCsv (String)
NewDeploymentPlanIdsCsv
Plans_CreateOrUpdateAction
Creates an action in the specified action group or updates an existing one.
ActionGroup_Id (Int32)
Action_Sequence (Int32)
Server_Id (Int32)
Server_Variable_Name (String)
Long_Description (String)
ResumeNextOnFailure_Indicator (YNIndicator)
Action_Configuration (String)
Short_Description (String)
Active_Indicator (YNIndicator)
Retry_Count (Int32)
LogFailureAsWarning_Indicator (YNIndicator)
Target_Server_Id (Int32)
Target_Server_Variable_Name (String)
ExtensionConfiguration_Id (Int32)
Action_Sequence
Plans_CreateOrUpdateDeploymentPlan
Creates a new deployment plan or changes the name of an existing deployment plan.
DeploymentPlan_Name (String)
AllowLocalChanges_Indicator (YNIndicator)
Application_Id (Int32)
DeploymentPlan_Id (Int32)
DeploymentPlan_Id
Plans_CreatePlan
Creates a new OtterScript deployment plan.
Plan_Name (String)
Application_Id (Int32)
Environment_Id (Int32)
PlanType_Code (String)
Plan_Bytes (Byte[])
Plan_Id (Int32)
Plan_Id
Plans_DeleteAction
Deletes an action from an action group.
DeploymentPlanActionGroup_Id (Int32)
Action_Sequence (Int32)
none
Plans_DeleteDeploymentPlan
Deletes a deployment plan.
DeploymentPlan_Id (Int32) none
Plans_DeleteDeploymentPlanActionGroup
Deletes the specified action group.
DeploymentPlanActionGroup_Id (Int32) none
Plans_DeletePlan
Deletes an OtterScript plan.
Plan_Id (Int32) none
Plans_GetAction
Gets the details of the specified action.
ActionGroup_Id (Int32)
Action_Sequence (Int32)
DataRow (ActionGroupActions_Extended)
Plans_GetActionGroup
Gets the details of the specified plan, and all the actions associated with the plan.
ActionGroup_Id (Int32) DataSet (ActionGroups, ActionGroupActions_Extended, ActionGroupUsage_Slim)
Plans_GetActionGroups
Gets all action groups.
none DataTable (ActionGroups)
Plans_GetDeploymentPlan
Returns action groups and actions for a deployment plan.
DeploymentPlan_Id (Int32)
IncludeActionUsage_Indicator (YNIndicator)
DataSet (DeploymentPlans, ApplicationDeploymentPlans, DeploymentPlanActionGroups_Extended, ActionGroupActions_Extended)
Plans_GetDeploymentPlanActionGroup
Gets the details of the specified plan, and all the actions associated with the plan.
DeploymentPlanActionGroup_Id (Int32) DataSet (DeploymentPlanActionGroups_Extended, ActionGroupActions_Extended, ActionGroupUsage_Slim, ApplicationDeploymentPlans)
Plans_GetDeploymentPlans
Returns the deployment plans in the system.
IncludeAnonymous_Indicator (YNIndicator) DataSet (DeploymentPlans, ApplicationDeploymentPlans)
Plans_GetGlobalDeploymentPlans
Returns named deployment plans and optionally plans orphaned.
none DataTable (DeploymentPlans)
Plans_GetPlan
Returns the specified OtterScript plan.
Plan_Id (Int32) DataRow (Plans_Extended)
Plans_GetPlanByName
Gets the plan which has the specified name and type that is visible to the specified application.
Application_Id (Int32)
Plan_Name (String)
PlanType_Code (String)
DataRow (Plans_Extended)
Plans_GetPlans
Returns all OtterScript plans of the specified type which are visible to the specified application.
Application_Id (Int32)
PlanType_Code (String)
DataTable (Plans_Extended)
Plans_GetPlansByName
Gets all plans in the system with the specified name and type.
Plan_Name (String)
PlanType_Code (String)
DataTable (Plans_Extended)
Plans_ResequenceAction
Changes the sequence of an action within a plan.
DeploymentPlanActionGroup_Id (Int32)
Action_Sequence (Int32)
New_Action_Sequence (Int32)
none
Plans_ResequenceActionGroup
Changes the sequence of a deployment plan action group.
DeploymentPlanActionGroup_Id (Int32)
New_DeploymentPlanActionGroup_Sequence (Int32)
none
Plans_UpdateActionGroup
Updates the specified action group.
ActionGroup_Id (Int32)
ActionGroup_Name (String)
ActionGroup_Description (String)
Predicate_Configuration (String)
Server_Id (Int32)
Server_Variable_Name (String)
none
Plans_UpdateDeploymentPlanActionGroup
Updates the specified deployment plan action group.
DeploymentPlanActionGroup_Id (Int32)
Active_Indicator (YNIndicator)
ActionGroup_Name (String)
ActionGroup_Description (String)
Predicate_Configuration (String)
Server_Id (Int32)
Server_Variable_Name (String)
Deployable_Name (String)
Deployable_Application_Id (Int32)
Iterate_Servers_Indicator (YNIndicator)
Iterate_Deployables_Indicator (YNIndicator)
Parallel_Indicator (YNIndicator)
OnSuccess_DeploymentPlanActionGroup_Id (Int32)
OnFailure_DeploymentPlanActionGroup_Id (Int32)
OnFailure_Continue_Indicator (YNIndicator)
none
Plans_UpdatePlan
Updates an OtterScript deployment plan.
Plan_Id (Int32)
Plan_Name (String)
Plan_Bytes (Byte[])
Environment_Id (Int32)
none
Promotions_AddApproval
Adds an approval for a promotion.
Application_Id (Int32)
Release_Number (String)
Build_Number (String)
PipelineStage_Name (String)
Requirement_Id (Int32)
RequirementType_Code (String)
User_Name (String)
Requirement_Description (String)
Comments_Text (String)
Approval_Id (Int32)
Approval_Id
Promotions_DeleteApproval
Deletes an approval for a promotion.
Approval_Id (Int32) none
Promotions_GetApprovalsReceived
Gets all requirements and approvals received for the specified promotion.
Application_Id (Int32)
Release_Number (String)
Build_Number (String)
PipelineStage_Name (String)
Approval_Id (Int32)
DataTable (BuildApprovalsReceived_Extended)
Promotions_GetScheduled
Gets scheduled promotions, optionally filtered by promotion and date.
Application_Id (Int32)
Release_Number (String)
Build_Number (String)
PipelineStage_Name (String)
Before_Date (DateTime)
DataTable (BuildPromotionsScheduled_Extended)
Promotions_SchedulePromotion
Schedules a promotion or removes a previously scheduled promotion.
Application_Id (Int32)
Release_Number (String)
Build_Number (String)
PipelineStage_Name (String)
PromoteOn_Date (DateTime)
none
Providers_CreateOrUpdateProvider
Creates a new provider or updates an existing one.
Provider_Id (Int32)
ProviderType_Code (String)
ExecuteOn_Server_Id (Int32)
Provider_Name (String)
Provider_Description (String)
Provider_Configuration (String)
Internal_Indicator (YNIndicator)
Provider_Id
Providers_DeleteProvider
Deletes the specified provider
Provider_Id (Int32) none
Providers_GetProvider
Gets the details of the specified provider
Provider_Id (Int32) DataRow (Providers)
Providers_GetProviders
Gets a list of providers in the system based on the specified criteria
ProviderType_Code (String)
Application_Id (Int32)
Environment_Id (Int32)
DataTable (Providers)
Releases_CancelRelease
Cancels the specified release.
Application_Id (Int32)
Release_Number (String)
CancelledReason_Text (String)
none
Releases_CreateOrUpdateRelease
Creates a release or updates an existing one.
Application_Id (Int32)
Release_Number (String)
Pipeline_Id (Int32)
Target_Date (DateTime)
Release_Name (String)
ReleaseTemplate_Name (String)
none
Releases_CreateOrUpdateReleaseDeployable
Sets the furthest build number for the release.
Application_Id (Int32)
Release_Number (String)
Deployable_Id (Int32)
Referenced_Application_Id (Int32)
Referenced_Release_Number (String)
none
Releases_CreateOrUpdateReleaseNote
Creates a new release note, or updates an existing one.
Application_Id (Int32)
Release_Number (String)
ReleaseNote_Sequence (Int32)
Build_Number (String)
Promotion_Id (Int32)
Notes_Text (String)
ReleaseNote_Sequence
Releases_DeleteReleaseDeployable
Removes a deployable from the release.
Application_Id (Int32)
Release_Number (String)
Deployable_Id (Int32)
none
Releases_DeleteReleaseNote
Deletes a release note from the system.
Application_Id (Int32)
Release_Number (String)
ReleaseNote_Sequence (Int32)
none
Releases_GetBuildExecutions
Gets the list of build executions for the specified release
Application_Id (Int32)
Release_Number (String)
DataTable (BuildExecutions_Extended)
Releases_GetDependentReleases
Gets all releases with referenced deployables from a specified release.
Application_Id (Int32)
Release_Number (String)
DataTable (Releases_Extended)
Releases_GetRelease
Gets the details of a specified release, the deployables associated with the release, and the configuration file versions associated with the release.
Application_Id (Int32)
Release_Number (String)
DataSet (Releases_Extended, ReleaseDeployables_Extended, ReleaseConfigurationFiles)
Releases_GetReleaseById
Gets the details of a specified release by ID.
Release_Id (Int32) DataRow (Releases_Extended)
Releases_GetReleaseDeployables
Gets the set of deployables associated with any release for an application.
Application_Id (Int32) DataTable (ReleaseDeployables_Extended)
Releases_GetReleaseNote
Gets a release note from the system.
Application_Id (Int32)
Release_Number (String)
ReleaseNote_Sequence (Int32)
DataRow (ReleaseNotes_Extended)
Releases_GetReleaseNotes
Gets the release notes that match the specified criteria.
Application_Id (Int32)
Release_Number (String)
Promotion_Id (Int32)
DataTable (ReleaseNotes_Extended)
Releases_GetReleases
Gets a list of releases that match the specified criteria.
Application_Id (Int32)
ReleaseStatus_Name (String)
Release_Count (Int32)
DataTable (Releases_Extended)
Releases_PurgeReleaseData
Purges an entire release and all associated data from the system.
Application_Id (Int32)
Release_Number (String)
none
Releases_ReleaseExists
Determines whether a release already exists, and also whether a newer release of an application exists
Application_Id (Int32)
Release_Number (String)
ReleaseExists_Indicator (YNIndicator)
NewerDeployedReleaseExists_Indicator (YNIndicator)
ReleaseExists_Indicator
NewerDeployedReleaseExists_Indicator
Releases_ResequenceRelease
Resequences the specified release by placing it where another release is sequenced.
Application_Id (Int32)
Release_Number (String)
Release_Sequence (Int64)
none
Releases_SetConfigurationFileVersion
Sets the configuration file version for the specified release.
Application_Id (Int32)
Release_Number (String)
ConfigurationFile_Id (Int32)
Version_Number (Int32)
none
Releases_UnCancelRelease
Restores a previously canceled release.
Application_Id (Int32)
Release_Number (String)
none
ReleaseTemplates_CreateOrUpdateTemplate
Creates a release template or updates an existing one.
Application_Id (Int32)
ReleaseTemplate_Name (String)
ReleaseTemplate_Configuration (String)
ReleaseTemplate_Id (Int32)
ReleaseTemplate_Id
ReleaseTemplates_DeleteTemplate
Deletes the specified release template.
ReleaseTemplate_Id (Int32) none
ReleaseTemplates_GetTemplate
Gets the specified release template.
ReleaseTemplate_Id (Int32) DataRow (ReleaseTemplates)
ReleaseTemplates_GetTemplateByName
Gets the specified release template by application and name.
Application_Id (Int32)
ReleaseTemplate_Name (String)
DataRow (ReleaseTemplates)
ReleaseTemplates_GetTemplates
Gets the release templates for the specified application.
Application_Id (Int32) DataTable (ReleaseTemplates)
RetentionPolicies_CreateOrUpdateRetentionPolicy
Creates or updates a retention policy.
RetentionPolicy_Name (String)
PurgeType_Code (String)
PurgeIn_Application_Id (Int32)
PurgeIn_ApplicationGroup_Id (Int32)
PurgeIn_OnlyDeployedReleases_Indicator (YNIndicator)
PurgeIn_OnlyRejectedBuilds_Indicator (YNIndicator)
PurgeOrphanedArtifacts_Indicator (YNIndicator)
PurgeIn_Pipeline_Id (Int32)
PurgeIn_Environment_Id (Int32)
PurgeIn_BuildStep_Indicator (YNIndicator)
Retention_Count (Int32)
Retention_Size (Int64)
Retention_Days_Count (Int32)
PurgeWindow_Start_Minutes (Int32)
PurgeWindow_Duration_Minutes (Int32)
Active_Indicator (YNIndicator)
RetentionPolicy_Id (Int32)
RetentionPolicy_Id
RetentionPolicies_DeleteRetentionPolicy
Deletes a retention policy.
RetentionPolicy_Id (Int32) none
RetentionPolicies_GetPurgeHistory
Gets the purge history for one or all retention policies.
RetentionPolicy_Id (Int32)
Max_Count (Int32)
DataTable (RetentionPoliciesPurgeHistory)
RetentionPolicies_GetPurgeLog
Gets the specified purge history log.
RetentionPoliciesPurgeHistoryEntry_Id (Int32) DataRow (RetentionPoliciesPurgeHistory)
RetentionPolicies_GetRetentionPolicies
Gets all of the retention policies.
Include_Inactive (String) DataTable (RetentionPolicies_Extended)
RetentionPolicies_GetRetentionPolicy
Gets the specified retention policy.
RetentionPolicy_Id (Int32) DataRow (RetentionPolicies_Extended)
RetentionPolicies_PurgeNow
Marks a retention policy as ready to run immediately.
RetentionPolicy_Id (Int32) none
ScriptAssets_CreateOrUpdateScript
Creates a new script or updates an existing one.
ScriptAsset_Name (String)
Application_Id (Int32)
Script_Text (Byte[])
ScriptAsset_Id (Int32)
ScriptAsset_Id
ScriptAssets_DeleteScript
Deletes a script.
ScriptAsset_Id (Int32) none
ScriptAssets_GetScript
Gets the script with the specified ID.
ScriptAsset_Id (Int32) DataRow (ScriptAssets)
ScriptAssets_GetScriptByName
Gets the script with the specified name, searching from the specified application.
ScriptAsset_Name (String)
Application_Id (Int32)
DataRow (ScriptAssets)
ScriptAssets_GetScripts
Gets the scripts which are visible to the specified application.
Application_Id (Int32) DataTable (ScriptAssets)
Scripts_CreateOrUpdateParameter
Creates a new script parameter or updates an existing one.
Script_Id (Int32)
Parameter_Name (String)
ParameterType_Code (String)
DefaultValue_Text (String)
Description_Text (String)
none
Scripts_CreateOrUpdateScript
Creates a new script or updates an existing one.
Script_Id (Int32)
Script_Name (String)
Description_Text (String)
ScriptType_Code (String)
Active_Indicator (YNIndicator)
AutoSync_Indicator (YNIndicator)
Script_Id
Scripts_CreateOrUpdateVariable
Creates a new script variable or updates an existing one.
Script_Id (Int32)
ScriptVariable_Name (String)
Value_Text (String)
none
Scripts_CreateVersion
Creates a new version of a script.
Version_Number (Int32)
Script_Id (Int32)
Script_Bytes (Byte[])
Version_Number
Scripts_DeleteParameter
Deletes a script parameter.
Script_Id (Int32)
Parameter_Name (String)
none
Scripts_DeleteScript
Permanently deletes a script.
Script_Id (Int32) none
Scripts_DeleteVariable
Deletes a script variable.
Script_Id (Int32)
ScriptVariable_Name (String)
none
Scripts_GetScript
Gets a script and all of its associated information.
Script_Id (Int32) DataSet (Scripts_Extended, ScriptParameters, ScriptVariables)
Scripts_GetScripts
Gets all of the scripts in the system, optionally filtered by type code.
ScriptType_Code (String)
IncludeInactive_Indicator (YNIndicator)
DataTable (Scripts_Extended)
Security_AddNamedUser
Assigns the specified user as a named user with the specified user class type
User_Name (String) none
Security_AddPrivilege
Grants or denies the specified principal the ability to perform a certain role
Privilege_Id (Int32)
UserDirectory_Id (Int32)
Principal_Name (String)
PrincipalType_Code (String)
Role_Id (Int32)
ApplicationGroup_Id (Int32)
Application_Id (Int32)
Environment_Id (Int32)
PrivilegeType_Code (String)
Privilege_Id
Security_CreateOrUpdateRole
Creates or updates a role.
Role_Id (Int32)
Role_Name (String)
Role_Description (String)
Tasks_Csv (String)
Role_Id
Security_DeleteRole
Deletes the specified role from the system
Role_Id (Int32) none
Security_GetNamedUser
Gets the specified named user
User_Name (String) DataRow (NamedUsers)
Security_GetNamedUsers
Gets a list of the named users in the system
none DataTable (NamedUsers)
Security_GetOrAddAnonymousRole
Gets an anonymous role containing the specified tasks, creating one if necessary.
Tasks_Csv (String)
Role_Id (Int32)
Role_Id
Security_GetPrivileges
Gets a list of privileges assigned in the system
UserDirectory_Id (Int32)
PrincipalType_Code (String)
DataTable (Privileges_Extended)
Security_GetRole
Gets the specified role, along with all the tasks that comprise the role.
Role_Id (Int32) DataSet (Roles, RoleTasks_Extended)
Security_GetRoles
Gets all the roles in the system, along with all the tasks comprising each role.
IncludeAnonymous_Indicator (YNIndicator) DataSet (Roles, RoleTasks_Extended)
Security_GetTasks
Gets all of the tasks in the system.
none DataTable (Tasks)
Security_RemoveNamedUser
Removes the specified user as a named user
User_Name (String) none
Security_RemovePrivilege
Deletes a privilege from the system.
Privilege_Id (Int32) none
Security_UserIsNamed
Determines whether or not a user is a named user in the system
User_Name (String)
UserIsNamed_Indicator (YNIndicator)
UserIsNamed_Indicator
ServerRoles_CreateOrUpdateServerRole
Creates or updates a server role.
ServerRole_Name (String)
ServerIds_Csv (String)
ServerRole_Id (Int32)
ServerRole_Id
ServerRoles_DeleteServerRole
Deletes the specified server and its configurations.
ServerRole_Id (Int32) none
ServerRoles_GetServerRole
Gets the specified server role.
ServerRole_Id (Int32) DataRow (ServerRoles_Extended)
ServerRoles_GetServerRoles
Gets all the servers roles in the system.
none DataTable (ServerRoles_Extended)
ServerRoles_GetServerRolesEnvironments
Gets all the server role and environment relations that match the specified criteria.
Environment_Id (Int32)
ServerRole_Id (Int32)
DataTable (ServerRolesEnvironments_Merged)
ServerRoles_GetServerRoleServers
Gets all the server role servers for a specific role, or all the roles in the system.
ServerRole_Id (Int32) DataTable (ServerRoleServers)
ServerRoles_SearchServerRoles
Searches servers roles in the system.
Environment_Id (Int32) DataTable (ServerRoles_Extended)
Servers_CreateOrUpdateServer
Creates a new server, or updates an existing one.
Server_Name (String)
Agent_Configuration (String)
Active_Indicator (YNIndicator)
ServerType_Code (String)
Restricted_Indicator (YNIndicator)
EnvironmentIds_Csv (String)
ServerIdsInGroup_Csv (String)
ServerRoleIds_Csv (String)
LogServerErrors_Indicator (YNIndicator)
Server_Id (Int32)
Server_Id
Servers_DeleteServer
Deletes a server.
Server_Id (Int32) none
Servers_GetServer
Gets the details of a specific server and its environments.
Server_Id (Int32) DataSet (Servers, Environments_Extended)
Servers_GetServerLogs
Gets the logs associated with the specified server.
Server_Id (Int32)
LogMessage_Count (Int32)
DataTable (LogMessages_Extended)
Servers_GetServers
Gets all the servers in the system.
IncludeInactive_Indicator (YNIndicator) DataTable (Servers)
Servers_GetServersInGroup
Gets all the servers in a specified server group.
ServerGroup_Server_Id (Int32)
IncludeInactive_Indicator (YNIndicator)
DataTable (Servers)
Servers_SearchServers
Gets all the servers specified by the filter, as well as their associated environments and roles.
Has_ServerRole_Id (Int32)
In_Environment_Id (Int32)
DataSet (Servers, ServerRoleServers, EnvironmentServers_Extended)
UserConfiguration_GetUserConfiguration
Gets the a complete list of user configuration settings
User_Name (String) DataTable (UserConfiguration)
UserConfiguration_GetValue
Gets the specified user configuration value
User_Name (String)
Key_Name (String)
Value_Text (String)
Value_Text
UserConfiguration_SetValue
Sets a user configuration value
User_Name (String)
Key_Name (String)
Value_Text (String)
none
Users_CreateOrUpdateGroup
Creates a new user group in the system
Group_Name (String)
Users_Xml (String)
none
Users_CreateOrUpdateUser
Creates a new user in the system or updates an existing one.
User_Name (String)
Display_Name (String)
Email_Address (String)
Groups_Xml (String)
ChangePasswordOnLogin_Indicator (YNIndicator)
none
Users_DeleteGroup
Deletes a user group from the system, but does not delete the users who belong to the group
Group_Name (String) none
Users_DeleteUser
Deletes a user from the system
User_Name (String) none
Users_GetGroups
Gets a list of user groups in the system
none DataTable (Groups)
Users_GetUser
Gets the details of the specified user, and a list of all the groups the user belongs to
User_Name (String) DataSet (Users, UserGroups)
Users_GetUsers
Gets all the users in the system, along with all group membership information.
none DataSet (Users, UserGroups)
Users_GetUsersInGroup
Gets a list of users in the specified group
Group_Name (String) DataTable (Users)
Users_SearchGroups
Gets a specific group by name, or if a wildcard search is performed, a group whose name starts with the specified name
Group_Name (String)
PerformWildcardSearch_Indicator (YNIndicator)
DataTable (Groups)
Users_SearchUsers
Gets the specified user, or searchs for a user whose name starts with any of the specified criteria
User_Name (String)
Display_Name (String)
Email_Address (String)
PerformWildcardSearch_Indicator (YNIndicator)
DataTable (Users)
Users_ValidateLogin
Validates the password of a specified user
User_Name (String)
Password_Text (String)
Validated_Indicator (YNIndicator)
Validated_Indicator
Variables_CreateOrUpdatePackageVariable
Creates a new package variable or sets an existing release package variable's value.
Build_Id (Int32)
Variable_Name (String)
ValueType_Code (String)
Variable_Value (Byte[])
Sensitive_Indicator (YNIndicator)
EvaluateVariables_Indicator (YNIndicator)
none
Variables_CreateOrUpdateReleaseVariable
Creates a new release variable or sets an existing release variable's value.
Release_Id (Int32)
Variable_Name (String)
ValueType_Code (String)
Variable_Value (Byte[])
Sensitive_Indicator (YNIndicator)
EvaluateVariables_Indicator (YNIndicator)
none
Variables_CreateOrUpdateVariable
Creates a new variable, or updates an existing variable with the specified ID or matching scope.
Variable_Name (String)
ValueType_Code (String)
Variable_Value (Byte[])
Environment_Id (Int32)
ServerRole_Id (Int32)
Server_Id (Int32)
ApplicationGroup_Id (Int32)
Application_Id (Int32)
Deployable_Id (Int32)
Sensitive_Indicator (YNIndicator)
EvaluateVariables_Indicator (YNIndicator)
Variable_Id (Int32)
Variable_Id
Variables_CreateOrUpdateVariableDeclaration
Creates a new variable declaration or updates an existing one.
VariableDeclaration_Id (Int32)
Variable_Name (String)
Scope_Code (String)
Scoped_Application_Id (Int32)
Scoped_PipelineStage_Name (String)
Scoped_Environment_Id (Int32)
Required_Indicator (YNIndicator)
Variable_Configuration (String)
DefaultValue_Text (String)
Sensitive_Indicator (YNIndicator)
VariableDeclaration_Id
Variables_CreateOrUpdateVariableDefinition
Creates a new variable definition or updates an existing one.
Variable_Name (String)
Environment_Id (Int32)
ServerRole_Id (Int32)
Server_Id (Int32)
ApplicationGroup_Id (Int32)
Application_Id (Int32)
Deployable_Id (Int32)
Release_Number (String)
Build_Number (String)
Promotion_Id (Int32)
Execution_Id (Int32)
Value_Text (String)
Sensitive_Indicator (YNIndicator)
none
Variables_DeletePackageVariable
Deletes a release package variable.
Build_Id (Int32)
Variable_Name (String)
none
Variables_DeleteReleaseVariable
Deletes a release variable.
Release_Id (Int32)
Variable_Name (String)
none
Variables_DeleteVariable
Deletes a variable.
Variable_Id (Int32) none
Variables_DeleteVariableDeclaration
Deletes a variable declaration.
VariableDeclaration_Id (Int32) none
Variables_DeleteVariableDefinition
Deletes a variable definition
VariableDefinition_Id (Int32) none
Variables_GetPackageVariables
Gets the package variables for a specific release package.
Build_Id (Int32) DataTable (BuildVariables)
Variables_GetReleaseVariables
Gets the release variables for a specific release.
Release_Id (Int32) DataTable (ReleaseVariables)
Variables_GetSystemVariableDefinitions
Gets the variable definitions for system-scoped variables.
none DataTable (VariableDefinitions_System)
Variables_GetVariable
Gets a variable from a specified id.
Variable_Id (Int32) DataRow (Variables)
Variables_GetVariableDeclaration
Gets the variable declaration in the system that has the specified ID.
VariableDeclaration_Id (Int32) DataRow (VariableDeclarations)
Variables_GetVariableDeclarations
Gets the variable declarations in the system that are defined in the specified scope.
Scope_Code (String)
Scoped_Application_Id (Int32)
Scoped_PiplineStage_Name (String)
Scoped_Environment_Id (Int32)
DataTable (VariableDeclarations)
Variables_GetVariableDefinition
Gets the specified variable definition.
VariableDefinition_Id (Int32) DataRow (VariableDefinitions_Extended)
Variables_GetVariableDefinitions
Gets the variable definitions in the system that are defined in the specified scope
Environment_Id (Int32)
ServerRole_Id (Int32)
Server_Id (Int32)
ApplicationGroup_Id (Int32)
Application_Id (Int32)
Deployable_Id (Int32)
Release_Id (Int32)
Build_Id (Int32)
Execution_Id (Int32)
DataTable (VariableDefinitions_Extended)
Variables_GetVariables
Gets all variables.
none DataTable (Variables)
Variables_GetVariablesAccessibleFromScope
Gets the variables that are defined in any of the specified scopes.
Environment_Id (Int32)
ServerRole_Id (Int32)
Server_Id (Int32)
ApplicationGroup_Id (Int32)
Application_Id (Int32)
Deployable_Id (Int32)
Variable_Name (String)
ExpandRolesAndEnvironments_Indicator (YNIndicator)
IncludeSystemVariables_Indicator (YNIndicator)
DataTable (Variables)
Variables_GetVariablesForScope
Gets the variables that are defined only in the specified scope.
Environment_Id (Int32)
ServerRole_Id (Int32)
Server_Id (Int32)
ApplicationGroup_Id (Int32)
Application_Id (Int32)
Deployable_Id (Int32)
DataTable (Variables)
Variables_GetVariableValues
Gets the variable values for the specified scope.
Environment_Id (Int32)
ServerRole_Id (Int32)
Server_Id (Int32)
ApplicationGroup_Id (Int32)
Application_Id (Int32)
Deployable_Id (Int32)
Release_Number (String)
Build_Number (String)
Promotion_Id (Int32)
Execution_Id (Int32)
DataTable (Variable_Values)