IFlexDeployFunctions (FlexDeploy Function SDK javadoc)

All Known Implementing Classes:

FlexDeploy2Functions, FlexDeployFunctions
```
public interface IFlexDeployFunctions
```

Method Summary

All Methods Instance Methods Abstract Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`activateBranch(java.lang.Long pProjectId, java.lang.String pBranchName)` Active a FlexDeploy Branch on a project.
`void`	`activateStream(java.lang.Long pProjectId, java.lang.String pStreamName)` Active a FlexDeploy Stream on a project.
`void`	`addFilesToPackage(java.lang.Long pProjectId, java.lang.String pPackageName, java.util.List<java.lang.String> pFiles)` Adds files to a given package.
`FlxWorkItemCommentDataObject`	`addWorkItemComment(java.lang.String pWorkItemNumber, java.lang.String pComment)` Adds a work item comment with the provided data.
`void`	`assignGroupToUser(java.lang.Long pGroupId, java.lang.Long pUserId)` Assigns Group to User with the provided data.
`void`	`assignGroupToUser(java.lang.String pGroupName, java.lang.String pUserName)` Assigns Group to User with the provided data.
`java.lang.Long`	`buildPackage(java.lang.Long pStreamId, ProjectPackagePojo projectPackage)` Builds a FlexDeploy Package.
`java.lang.Long`	`buildPackage(java.lang.Long pStreamId, ProjectPackagePojo projectPackage, BuildOptions pBuildOptions)` Builds a FlexDeploy Package.
`java.lang.Long`	`buildPackage(java.lang.Long pStreamId, ProjectPackagePojo projectPackage, PollingResult pPollingResult)` Builds a FlexDeploy Package using a PollingResult.
`java.lang.Long`	`buildPackage(java.lang.Long pStreamId, ProjectPackagePojo projectPackage, PollingResult pPollingResult, BuildOptions pBuildOptions)` Builds a FlexDeploy Package using a PollingResult.
`java.lang.Long`	`buildProject(java.lang.Long pStreamId, java.lang.Long pProjectId)` Builds a FlexDeploy Project.
`java.lang.Long`	`buildProject(java.lang.Long pStreamId, java.lang.Long pProjectId, BuildOptions pBuildOptions)` Builds a FlexDeploy Project.
`java.lang.Long`	`buildProject(java.lang.Long pStreamId, java.lang.Long pProjectId, PollingResult pPollingResult)` Builds a FlexDeploy Project using a PollingResult.
`java.lang.Long`	`buildProject(java.lang.Long pStreamId, java.lang.Long pProjectId, PollingResult pPollingResult, BuildOptions pBuildOptions)` Builds a FlexDeploy Project using a PollingResult.
`java.lang.Long`	`createBranch(java.lang.Long pProjectId, ProjectStreamPojo pBranch)` Create a FlexDeploy Branch on a given project.
`java.lang.Long`	`createBranch(java.lang.Long pProjectId, java.lang.String pBranchName)` Create a FlexDeploy Branch on a given project.
`java.lang.Long`	`createBranch(java.lang.Long pProjectId, java.lang.String pBranchName, java.lang.String pVersionSyntax)` Create a FlexDeploy Branch on a given project.
`CredentialDataObject`	`createCredential(CredentialDataObject pCredentialDataObject)` Create Credential with the provided data.
`java.lang.Long`	`createDynamicPackage(java.lang.Long pProjectId, java.lang.String pPackageName, java.lang.String pDescription, java.lang.String pIncludePath, java.lang.String pExcludePath)` Creates a dynamic package for given include and exclude path.
`EndpointDataObject`	`createEndpoint(EndpointDataObject pEndpointDataObject)` Create Endpoint with the provided data.
`EnvironmentDataObject`	`createEnvironment(EnvironmentDataObject pEnvDataObject)` Create Environment with the provided data.
`FlxWorkItemFieldDataObject`	`createFlxWorkItemField(FlxWorkItemFieldDataObject pDobj)` Creates a Flex Work Item Field with the provided data.
`PropertyKeyGroupDataObject`	`createFlxWorkItemFieldGroup(PropertyKeyGroupDataObject pDobj)` Creates a Flex Work Item Field Group with the provided data.
`FolderDataObject`	`createFolder(FolderDataObject pFolderDataObject)` Create Folder with the provided data.
`FdGroupDataObject`	`createGroup(FdGroupDataObject pGroupDataObject)` Create Group with the provided data.
`CMSObject`	`createIncidentByWorkflowType(java.lang.Long pWorkflowRequestId, java.util.Map<java.lang.String,java.io.Serializable> pIncidentFields)` Returns a CMSObject with incident details.
`CMSObject`	`createIncidentForWorklowRequest(java.lang.Long pWorkflowRequestId, java.util.Map<java.lang.String,java.io.Serializable> pIncidentFields, java.lang.String pCMSInstanceCode, java.lang.String pCMSInstanceName)` Returns a CMSObject with incident details for a particular CMS Instance by searching with Instance Name and Instance Code.
`java.lang.Long`	`createPackage(java.lang.Long pProjectId, java.lang.String pPackageName, java.lang.String pDescription, java.util.List<java.lang.String> pFiles)` Creates a package for a given project and list of files.
`java.lang.Long`	`createPackage(java.lang.Long pProjectId, java.lang.String pPackageName, java.lang.String pDescription, java.lang.Long pStreamId, PollingResult pPollingResult)` Creates a package for a given project relative to a PollingResult.
`java.lang.Long`	`createProject(ProjectPojo pProjectPojo)` Creates and configures a project with the provided data.
`ProjectTriggerDataObject`	`createProjectTrigger(ProjectTriggerDataObject pPojo)` Creates a project trigger with the provided data.Returns the project trigger details after creation.
`PropertyKeyDefinitionDataObject`	`createPropertyKeyDefinition(PropertyKeyDefinitionDataObject pPojo)` Creates a property key definition with the provided data.
`java.lang.Long`	`createSCMInstance(SCMInstancePojo pSCMInstancePojo)` Creates and configures an SCM instance with the given data.
`java.lang.Long`	`createSCMInstance(java.lang.String pSCMInstanceName, java.lang.String pDescription, java.lang.Boolean pIsActive, java.lang.String pInstanceCode, java.util.List<PropertyValuePojo> pProperties, java.lang.String pSCMType)` Creates and configures an SCM Instance with the provided data.
`java.lang.Long`	`createStream(java.lang.Long pProjectId, ProjectStreamPojo pStream)` Create a FlexDeploy Stream on a given project.
`java.lang.Long`	`createStream(java.lang.Long pProjectId, java.lang.String pStreamName)` Create a FlexDeploy Stream on a given project.
`java.lang.Long`	`createStream(java.lang.Long pProjectId, java.lang.String pStreamName, java.lang.String pVersionSyntax)` Create a FlexDeploy Stream on a given project.
`TargetGroupDataObject`	`createTargetGroup(TargetGroupDataObject pTargetGroupDataObj)` Create TargetGroup with the provided data.
`FdUserDataObject`	`createUser(FdUserDataObject pUserDataObj)` Create User with the provided data.
`FlxWorkItemDataObject`	`createWorkItem(FlxWorkItemDataObject pPojo)` Creates a work item with the provided data.Returns the work item details after creation.
`void`	`deleteCredential(java.lang.Long pCredentialId)` Deletes a Credential.
`void`	`deleteEndpoint(java.lang.Long pEndpointId)` Deletes an Endpoint.
`void`	`deleteEnvironment(java.lang.Long pEnvironmentId)` Deletes an Environment.
`void`	`deleteFlxWorkItem(java.lang.Long pFlexWorkItemId)` Deletes a Flex Work Item
`void`	`deleteFlxWorkItemField(java.lang.Long pFlexWorkItemFieldId)` Deletes a Flex Work Item Field
`void`	`deleteFlxWorkItemFieldGroup(java.lang.String pFlexWorkItemFieldGroupCode)` Deletes a Flex Work Item Field Group
`void`	`deleteFolder(java.lang.Long pFolderId)` Deletes a Folder.
`void`	`deletePackage(java.lang.Long pProjectId, java.lang.String pPackageName)` Deletes a project package
`void`	`deleteProjectTrigger(java.lang.Long pProjectTriggerId)` Deletes the project trigger based on Project Trigger id.
`void`	`deleteTargetGroup(java.lang.Long pTargetGroupId)` Deletes a TargetGroup.
`java.lang.Long`	`deployPackage(java.lang.Long pProjectId, java.lang.String pPackageName, java.lang.String pEnvironmentCode, DeployOptions pDeployOptions)` Deploys a FlexDeploy Package.
`java.lang.Long`	`deployProject(java.lang.Long pProjectId, java.lang.String pEnvironmentCode, DeployOptions pDeployOptions)` Deploys a FlexDeploy Project.
`java.lang.Integer`	`discoverFiles(java.lang.Long pProjectId, java.lang.Long pStreamId)` Populate partial deployment files for a given project.
`void`	`downloadLogs(java.lang.Long pWorkflowExecutionId, java.lang.String pDestinationPath)` Downloads the plugin logs from the workflow execution based on Id.
`java.lang.Long`	`executeUtility(java.lang.Long pProjectId, java.lang.String pEnvironmentCode)` Executes a FlexDeploy Utility Project for a single environment on all instances configured in Project Configuration.
`java.lang.Long`	`executeUtility(java.lang.Long pProjectId, java.lang.String pEnvironmentCode, ExecuteOptions pExecuteOptions)` Executes a FlexDeploy Utility Project for a single environment with specified ExecuteOptions.
`java.lang.Long`	`findBranchId(java.lang.Long pProjectId, java.lang.String pBranchName)` Finds a FlexDeploy branch id from the Branch name.
`CMSInstancePojo`	`findCMSInstance(java.lang.String pCMSInstanceCode)` Gets a CMSInstance based on the CMS Instance Code passed.
`java.util.List<EnvironmentPojo>`	`findEnvironment(java.lang.String pEnvironmentCode)` Gets the environment with the specified enviornment code.
`java.lang.Long`	`findFolderId(java.lang.String pFolderName)` Finds the FlexDeploy Folder id for any given name.
`java.util.List<FolderDataObject>`	`findFoldersWithName(java.lang.String pFolderName)` Finds FlexDeploy Folders for any given name
`FolderDataObject`	`findFolderWithId(java.lang.Long pFolderId)` Finds Folder using Id.
`IntegrationInstancePojo`	`findIntegrationInstance(java.lang.String pIntegrationInstanceCode, java.lang.String pType)` Gets an integration instance based on the code.
`PollingResult`	`findLocalChangeLogs(java.lang.String pUrl, java.lang.String pBranch, java.lang.String pCurrentRevision, java.lang.String pFromRevision)` Finds change logs for a local ssh enabled git repository.
`PollingResult`	`findLocalChangeLogs(java.lang.String pUrl, java.lang.String pBranch, java.lang.String pCurrentRevision, java.lang.String pFromRevision, boolean pIgnoreTargetBranchMerge)` Finds change logs for a local ssh enabled git repository.
`PollingResult`	`findLocalChangeLogs(java.lang.String pUrl, java.lang.String pBranch, java.lang.String pCurrentRevision, java.lang.String pFromRevision, java.lang.String pUser, java.lang.String pPassword)` Finds change logs for a local git repository.
`PollingResult`	`findLocalChangeLogs(java.lang.String pUrl, java.lang.String pBranch, java.lang.String pCurrentRevision, java.lang.String pFromRevision, java.lang.String pUser, java.lang.String pPassword, boolean pIgnoreTargetBranchMerge)` Finds change logs for a local ssh enabled git repository.
`java.util.Set<ProjectPackagePojo>`	`findPackagesForChange(java.lang.String pRepositoryName, java.lang.String pStreamName, java.util.List<java.lang.String> pChangedFiles)` Finds relevant FlexDeploy Packages for a list of changed files.
`java.util.Set<ProjectPackagePojo>`	`findPackagesForChange(java.lang.String pRepositoryName, java.lang.String pStreamName, PollingResult pPollingResult)` Finds relevant FlexDeploy Packages for any given PollingResult.
`java.lang.Long`	`findProjectId(java.lang.String pProjectName)` Finds the FlexDeploy Project id for any given name.
`java.util.Set<java.lang.Long>`	`findProjectsForChange(java.lang.String pRepositoryName, java.lang.String pStreamName, java.util.List<java.lang.String> pChangedFiles)` Finds relevant FlexDeploy Projects for a list of changed files.
`java.util.Set<java.lang.Long>`	`findProjectsForChange(java.lang.String pRepositoryName, java.lang.String pStreamName, PollingResult pPollingResult)` Finds relevant FlexDeploy Projects for any given PollingResult and stream.
`java.util.Set<java.lang.Long>`	`findProjectsForNewBranch(java.lang.String pRepositoryName)` Finds relevant FlexDeploy Projects for a new branch event.
`java.util.Set<java.lang.Long>`	`findProjectsForNewBranch(java.lang.String pRepositoryName, PollingResult pPollingResult)` Finds relevant FlexDeploy Projects for a new branch event.
`java.util.List<ProjectDataObject>`	`findProjectsWithName(java.lang.String pProjectName)` Finds FlexDeploy Projects for any given name
`ProjectDataObject`	`findProjectWithId(java.lang.Long pProjectId)` Finds Project using Id.
`java.lang.Long`	`findStreamId(java.lang.Long pProjectId, java.lang.String pStreamName)` Finds a FlexDeploy stream id from the Stream name.
`FlxWorkItemDataObject`	`findWorkItemByNumber(java.lang.String pWorkItemNumber)` Gets work item based on work item number.
`java.util.List<FlexFieldMetadataDataObject>`	`getActiveBuildFlexfieldMetadata()` Gets active build flexfields metadata.
`java.util.List<FlexFieldMetadataDataObject>`	`getActiveDeployUtilityFlexfieldMetadata()` Gets active deploy or utility flexfields metadata.
`java.util.List<TasksQueryResultPojo>`	`getApprovedPipelineStageGateTasks(java.lang.Long pPipelineStageExecId)` Gets Task details based on pipeline stage execution id.
`ChangeManagementSystem`	`getChangeManagementSystemByInstanceCode(java.lang.String pInstanceCode)` Returns a CMS System for a particular CMS Instance by searching with Instance Code.
`ChangeManagementSystem`	`getChangeManagementSystemByInstanceId(java.lang.Long pCMSInstanceId)` Returns a CMS System for a particular CMS Instance Id.
`ChangeManagementSystem`	`getChangeManagementSystemByInstanceName(java.lang.String pInstanceName)` Returns a CMS System for a particular CMS Instance by searching with Instance Name.
`CMSInstancePojo`	`getCMSInstance(java.lang.Long pCMSInstanceId)` Gets a CMSInstance based on the CMS Instance Id passed.
`CredentialDataObject`	`getCredentialById(java.lang.Long pCredentialId)` Returns Credential information for a given Credential Id.
`CredentialDataObject`	`getCredentialByName(java.lang.String pCredentialName)` Returns Credential information for a given Credential name.
`java.lang.Long`	`getCurrentlyDeployedVersionId(java.lang.Long pProjectId, java.lang.Long pEnvironmentId, java.lang.Long pInstanceId)` Returns currently deployed project version Id of full deployment project.
`java.lang.Long`	`getCurrentlyDeployedVersionId(java.lang.Long pProjectId, java.lang.Long pEnvironmentId, java.lang.Long pInstanceId, java.lang.String pPackageName)` Returns currently deployed project version Id of partial deployment project.
`EndpointDataObject`	`getEndpointById(java.lang.Long pEndpointId)` Returns Endpoint information for a given endpoint Id.
`EndpointDataObject`	`getEndpointByName(java.lang.String pEndpointName)` Returns Endpoint information for a given Endpoint Name.
`EnvironmentPojo`	`getEnvironment(java.lang.Long pEnvironmentId)` Gets the environment with the specified Id.
`EnvironmentDataObject`	`getEnvironmentByCode(java.lang.String pEnvironmentCode)` Returns Environment information for a given environment code.
`EnvironmentDataObject`	`getEnvironmentById(java.lang.Long pEnvironmentId)` Returns Environment information for a given environment Id.
`EnvironmentDataObject`	`getEnvironmentByName(java.lang.String pEnvironmentName)` Returns Environment information for a given environmentName
`java.lang.String`	`getFlexDeployBaseUrl()` Returns the FlexDeploy Server base url configured in System Settings.
`PropertyKeyGroupDataObject`	`getFlxWorkItemFieldGroupWithCode(java.lang.String pFlexWorkItemFieldGroupCode)` Finds a Flex Work Item Field Group using Code.
`FlxWorkItemFieldDataObject`	`getFlxWorkItemFieldWithId(java.lang.Long pFlexWorkItemFieldId)` Finds Flex Work Item Field using Id.
`FlxWorkItemStatusDataObject`	`getFlxWorkItemStatusWithId(java.lang.Long pFlexWorkItemStatusId)` Finds Flex Work Item Status using Id.
`FlxWorkItemTypeDataObject`	`getFlxWorkItemTypeWithCode(java.lang.String pFlexWorkItemTypeCode)` Finds Flex Work Item Type using Code.
`FdGroupDataObject`	`getGroupById(java.lang.Long pGroupId)` Returns Group information for a given group Id.
`FdGroupDataObject`	`getGroupByName(java.lang.String pGroupName)` Returns Group information for a given group name.
`IntegrationInstancePojo`	`getIntegrationInstance(java.lang.Long pIntegrationInstanceId, java.lang.String pType)` Gets an integration instance based on the id.
`IssueTrackingSystem`	`getIssueTrackingSystemByInstanceCode(java.lang.String pInstanceCode)` Returns a ITS System for a particular ITS Instance Code.
`IssueTrackingSystem`	`getIssueTrackingSystemByInstanceId(java.lang.Long pITSInstanceId)` Returns a ITS System for a particular ITS Instance Id.
`IssueTrackingSystem`	`getIssueTrackingSystemByInstanceName(java.lang.String pInstanceName)` Returns a ITS System for a particular ITS Instance Name.
`java.lang.Long`	`getMatchingProjectObjectId(java.lang.Long pProjectId, java.lang.String pFile)` Returns internal id for file in a project.
`PackageDetailsResponsePojo`	`getPackage(java.lang.Long pProjectId, java.lang.String pPackageName)` Returns a PackageDetailsResponsePojo given a Project Id and Package Name
`java.util.List<TasksQueryResultPojo>`	`getPipelineStageGateTasks(java.lang.Long pPipelineStageExecId)` Gets Task details based on pipeline stage execution id.
`java.util.Map<java.lang.Long,java.io.InputStream>`	`getPluginLogInputStreams(java.lang.Long pWorkflowExecutionId)` Returns plugin logs from a workflow execution as a map with the key being the plugin execution id and value as an InputStream of log data.
`java.util.Map<java.lang.Long,java.io.InputStream>`	`getPluginLogInputStreams(java.lang.Long pWorkflowExecutionId, java.lang.Boolean pOnlyError)` Returns plugin logs from a workflow execution as a map with the key being the plugin execution id and value as an InputStream of log data.
`java.util.Collection<PluginLogPojo>`	`getPluginLogs(java.lang.Long pWorkflowExecutionId)` Gets the plugin logs from the workflow execution based on Id.
`java.lang.Long`	`getPreviouslyDeployedVersionId(java.lang.Long pProjectId, java.lang.Long pEnvironmentId, java.lang.Long pInstanceId)` Returns previously deployed project version Id of full deployment project.
`java.lang.Long`	`getPreviouslyDeployedVersionId(java.lang.Long pProjectId, java.lang.Long pEnvironmentId, java.lang.Long pInstanceId, java.lang.String pPackageName)` Returns previously deployed project version Id of partial deployment project.
`ProjectPojo`	`getProject(java.lang.Long pProjectId)` Returns project information for a given projectId.
`ProjectStreamDataObject`	`getProjectBranchById(java.lang.Long pBranchId, java.lang.Long pProjectId)` Returns the project branch details for given branchId and projectId
`ProjectTriggerDataObject`	`getProjectTriggerById(java.lang.Long pProjectTriggerId)` Returns the project trigger information based on Project Trigger id.
`ProjectVersionDataObject`	`getProjectVersionById(java.lang.Long pProjectVersionId, java.lang.Long pProjectId)` Gets project version data object by project version id and project Id.
`PropertyKeyDefinitionDataObject`	`getPropertyKeyDefinition(java.lang.Long pPropertyKeyDefinitionId)` Retrieves a property key definition by its ID.
`PropertyKeyDefinitionDataObject`	`getPropertyKeyDefinition(java.lang.String pKeyName)` Retrieves a property key definition by its key name.
`PropertySetDataObject`	`getPropertySet(java.lang.Long pPropertySetId)` Retrieves a property set by its ID.
`java.io.InputStream`	`getReportDataByWorkflowExecutionReportId(java.lang.Long pWorkflowExecutionReportId)` Get a report by Workflow Execution Report ID.
`java.util.List<WorkflowExecutionReportDataObject>`	`getReportsByWorkflowExecutionId(java.lang.Long pWorkflowExecutionId)` Gets a list of WorkflowExecutionReportDataObject objects that are associated with a workflow execution
`ScanResultPojo`	`getScanResultForSonarqube(java.lang.String pBaseUrl, java.lang.String pProjectKey)` get Scan result for SonarQube
`RelSnapshotDataObject`	`getSnapshotDetails(java.lang.Long pSnapshotId)` Return a release snapshot data object by id.
`TargetGroupDataObject`	`getTargetGroupByCode(java.lang.String pTargetGroupCode)` Get the TargetGroup based on TargetGroup code passed.
`TargetGroupDataObject`	`getTargetGroupById(java.lang.Long pTargetGroupId)` Get the TargetGroup based on TargetGroup id passed.
`TargetGroupDataObject`	`getTargetGroupByName(java.lang.String pTargetGroupName)` Get the TargetGroup based on TargetGroup name passed.
`FdUserDataObject`	`getUser(java.lang.String pUsername)` Returns user information for a given username.
`FdUserDataObject`	`getUserById(java.lang.Long pUserId)` Returns User information along with the user attributes and group detail for a given user Id.
`java.util.List<FDUser>`	`getUsersFromGroupId(java.lang.Long pGroupId)` Gets a list of FDUser objects that are members of the group with the given group Id.
`java.util.List<FDUser>`	`getUsersFromGroupName(java.lang.String pGroupName)` Gets a list of FDUser objects that are members of the group with the given group name.
`WorkflowExecutionDataObject`	`getWorkflowExecutionById(java.lang.Long pWorkflowExecutionId)` Gets workflow execution details for workflow execution id.
`java.util.List<WorkflowExecutionDataObject>`	`getWorkflowExecutionByWorkflowRequestId(java.lang.Long pWorkflowRequestId)` Gets workflow execution details by workflow request id.
`java.util.List<ScmCommitDataObject>`	`getWorkflowExecutionCommits(java.lang.Long pWorkflowExecutionId)` Gets Commit details associated with workflow execution.
`java.util.List<CodeValueInputPOJO>`	`getWorkflowExecutionFlexfields(java.lang.Long pWorkflowExecutionId)` Gets workflow execution flexfields details for workflow execution id.
`java.util.List<CodeValueInputPOJO>`	`getWorkflowExecutionInputs(java.lang.Long pWorkflowExecutionId)` Gets workflow execution inputs details for workflow execution id.
`java.util.List<CodeValueInputPOJO>`	`getWorkflowExecutionOutputs(java.lang.Long pWorkflowExecutionId)` Gets workflow execution output details for workflow execution id.
`WorkflowExecutionVariables`	`getWorkflowExecutionVariables(java.lang.Long pWorkflowExecutionId)` Gets workflow execution variables for workflow execution id.
`java.util.List<WorkItemDataObject>`	`getWorkflowExecutionWorkItems(java.lang.Long pWorkflowExecutionId)` Gets WorkItem details associated with workflow execution.
`java.util.List<TasksQueryResultPojo>`	`getWorkflowRequestTasks(java.lang.Long pWorkflowRequestId)` Gets Task details based on workflow request id.
`java.util.List<FlxWorkItemFieldDataDataObject>`	`getWorkItemFieldData(java.lang.String pWorkItemNumber)` Returns List of work item field details for work item number.
`java.util.List<WorkItemDataObject>`	`getWorkItemsForAllExecutions(java.lang.Long pSnapshotId, java.lang.Long pEnvironmentId)` Gets Work Item details associated with all execution for given snapshort and environment.
`java.util.List<WorkItemDataObject>`	`getWorkItemsForFailedExecutions(java.lang.Long pSnapshotId, java.lang.Long pEnvironmentId)` Gets Work Item details associated with failed execution for given snapshort and environment.
`java.util.List<WorkItemDataObject>`	`getWorkItemsForSnapshotVersions(java.lang.Long pSnapshotId)` Gets Work Item details associated with snapshort versions.
`java.util.List<WorkItemDataObject>`	`getWorkItemsForSuccessfulExecutions(java.lang.Long pSnapshotId, java.lang.Long pEnvironmentId)` Gets Work Item details associated with successful execution for given snapshort and environment.
`java.lang.String`	`getWorkItemStatus(WorkItemDataObject pWorkItem)` Gets Work Item Status.
`java.util.List<FlxWorkItemStatusDataObject>`	`getWorkItemStatuses()` Gets the work item statuses.
`java.util.List<FlxWorkItemTypeDataObject>`	`getWorkItemTypes()` Gets the work item types.
`void`	`inactivateBranch(java.lang.Long pProjectId, java.lang.String pBranchName)` Inactivates a project stream using AM method to patch stream
`void`	`inactivateStream(java.lang.Long pProjectId, java.lang.String pStreamName)` Inactivates a project stream using AM method to patch stream
`boolean`	`isBotUsername(java.lang.String pUsername)` Return whether an username (case-insensitive) is a FlexDeploy bot username and not a FlexDeploy user.
`java.lang.String`	`parseWorkItemRichText(java.lang.String pWorkItemRichText)` Parse Rich Text to retrieve raw text.
`void`	`patchBranch(java.lang.Long pProjectId, java.lang.Long pBranchId, ProjectStreamDataObject pBranch)` Patches a FlexDeploy Branch on a given project.
`CredentialDataObject`	`patchCredential(CredentialDataObject pCredentialDataObject)` Update Credential with the provided data.
`EndpointDataObject`	`patchEndpoint(EndpointDataObject pEndpointDataObject)` Update Endpoint with the provided data.
`EnvironmentDataObject`	`patchEnvironment(EnvironmentDataObject pEnvDataObject)` Update Environment with the provided data.
`FlxWorkItemFieldDataObject`	`patchFlxWorkItemField(FlxWorkItemFieldDataObject pPojo)` Patches a Flex Work Item Field with the provided data.
`PropertyKeyGroupDataObject`	`patchFlxWorkItemFieldGroup(PropertyKeyGroupDataObject pDobj)` Patches a Flex Work Item Field Group with the provided data.
`FolderDataObject`	`patchFolder(FolderDataObject pFolderDataObject)` Update Folder with the provided data.
`FdGroupDataObject`	`patchGroup(FdGroupDataObject pGroupDataObject)` Update Group with the provided data.
`java.lang.Long`	`patchProject(java.lang.Long pProjectId, ProjectPojo pProjectPojo)` Updates a project with the provided data.
`java.lang.Long`	`patchProjectProperties(java.lang.Long pProjectId, java.util.List<PropertyValuePojo> pPropertyPojos)` Updates a project's properties with the provided data.
`ProjectTriggerDataObject`	`patchProjectTrigger(ProjectTriggerDataObject pPojo)` Updates a project trigger with the provided data.
`PropertyKeyDefinitionDataObject`	`patchPropertyKeyDefinition(PropertyKeyDefinitionDataObject pPojo)` Updates a property key definition with the provided data.
`void`	`patchStream(java.lang.Long pProjectId, java.lang.Long pStreamId, ProjectStreamDataObject pStream)` Patches a FlexDeploy Stream on a given project.
`TargetGroupDataObject`	`patchTargetGroup(TargetGroupDataObject pTargetGroupDataObj)` Update TargetGroup with the provided data.
`FdUserDataObject`	`patchUser(FdUserDataObject pUserDataObject)` Update User with the provided data.
`FlxWorkItemDataObject`	`patchWorkItem(FlxWorkItemDataObject pPojo)` Patches a work item with the provided data.
`FlxWorkItemCommentDataObject`	`patchWorkItemComment(java.lang.String pWorkItemCommentId, java.lang.String pComment)` Update a work item comment with the provided data.
`java.lang.Integer`	`populateFiles(java.lang.Long pProjectId, java.lang.Long pStreamId)` Deprecated.
`java.util.List<FlxWorkItemFieldDataObject>`	`saveFlxWorkItemFields(java.util.List<FlxWorkItemFieldDataObject> pPojos, java.lang.String pGroupCode)` Updates all Flex Work Item Fields within a group.
`java.util.List<FlxWorkItemFieldDataDataObject>`	`saveWorkItemFieldData(java.lang.String pWorkItemNumber, java.lang.String pFieldName, java.io.Serializable pValue)` Saves work item field data on given work item number, field name and value.
`PaginatedResponse<ProjectStreamDataObject>`	`searchBranches(ProjectStreamDataObject pCriteriaObject, java.lang.Integer pLimit, java.lang.Integer pOffset)` Find Branches using criteria values provided.
`PaginatedResponse<CredentialDataObject>`	`searchCredentials(CredentialDataObject pCriteriaObject, java.lang.Integer pLimit, java.lang.Integer pOffset)` Find Credentials using criteria values provided.
`PaginatedResponse<EndpointDataObject>`	`searchEndpoints(EndpointDataObject pCriteriaObject, java.lang.Integer pLimit, java.lang.Integer pOffset)` Find Endpoints using criteria values provided.
`PaginatedResponse<EnvironmentDataObject>`	`searchEnvironments(EnvironmentDataObject pCriteriaObject, java.lang.Integer pLimit, java.lang.Integer pOffset)` Find Environments using criteria values provided.
`PaginatedResponse<PropertyKeyGroupDataObject>`	`searchFlxWorkItemFieldGroups(PropertyKeyGroupDataObject pCriteriaObject, java.lang.Integer pLimit, java.lang.Integer pOffset)` Returns a list of Flex Work Item Field Groups based on criteria values provided.
`PaginatedResponse<FlxWorkItemFieldDataObject>`	`searchFlxWorkItemFields(FlxWorkItemFieldDataObject pCriteriaObject, java.lang.Integer pLimit, java.lang.Integer pOffset)` Returns a list of Flex Work Item Fields based on criteria values provided.
`PaginatedResponse<FlxWorkItemDataObject>`	`searchFlxWorkItems(FlxWorkItemDataObject pCriteriaObject, java.lang.Integer pLimit, java.lang.Integer pOffset)` Returns a list of Flex Work Items based on criteria values provided.
`PaginatedResponse<FlxWorkItemStatusDataObject>`	`searchFlxWorkItemStatuses(FlxWorkItemStatusDataObject pCriteriaObject, java.lang.Integer pLimit, java.lang.Integer pOffset)` Returns a list of Flex Work Item Statuses based on criteria values provided.
`PaginatedResponse<FlxWorkItemTypeDataObject>`	`searchFlxWorkItemTypes(FlxWorkItemTypeDataObject pCriteriaObject, java.lang.Integer pLimit, java.lang.Integer pOffset)` Returns a list of Flex Work Item Types based on criteria values provided.
`PaginatedResponse<FolderDataObject>`	`searchFolders(FolderDataObject pCriteriaObject, java.lang.Integer pLimit, java.lang.Integer pOffset)` Find Folders using criteria values provided.
`PaginatedResponse<FdGroupDataObject>`	`searchGroups(FdGroupDataObject pGroupObject, java.lang.Integer pLimit, java.lang.Integer pOffset)` Find Groups using criteria values provided.
`PaginatedResponse<ProjectPackageDataObject>`	`searchProjectPackages(ProjectPackageDataObject pCriteriaObject, java.lang.Integer pLimit, java.lang.Integer pOffset)` Find Packages using criteria values provided.
`PaginatedResponse<ProjectDataObject>`	`searchProjects(ProjectDataObject pCriteriaObject, java.lang.Integer pLimit, java.lang.Integer pOffset)` Find Projects using criteria values provided.
`PaginatedResponse<ProjectTriggerDataObject>`	`searchProjectTriggers(ProjectTriggerDataObject pCriteriaObject, java.lang.Integer pLimit, java.lang.Integer pOffset)` Find Project Triggers using criteria values provided.
`PaginatedResponse<ProjectVersionDataObject>`	`searchProjectVersions(ProjectVersionDataObject pParameters, java.lang.Integer pLimit, java.lang.Integer pOffset)` Find Project Versions using criteria values provided.
`PaginatedResponse<PropertyKeyDefinitionDataObject>`	`searchPropertyKeyDefinitions(PropertyKeyDefinitionDataObject pSearchParams, java.lang.Integer pLimit, java.lang.Integer pOffset)` Searches for property key definitions based on the provided search parameters and pagination input.
`PaginatedResponse<PropertySetDataObject>`	`searchPropertySets(PropertySetDataObject pSearchParams, java.lang.Integer pLimit, java.lang.Integer pOffset)` Searches for property sets based on the provided search parameters and pagination input.
`PaginatedResponse<TargetGroupDataObject>`	`searchTargetGroups(TargetGroupDataObject pCriteriaObject, java.lang.Integer pLimit, java.lang.Integer pOffset)` Find TargetGroups using criteria values provided.
`PaginatedResponse<FdUserDataObject>`	`searchUsers(FdUserDataObject pUserObject, java.lang.Integer pLimit, java.lang.Integer pOffset)` Find Users using criteria values provided.
`void`	`unassignGroupFromUser(java.lang.Long pGroupId, java.lang.Long pUserId)` Unassigns Group from User with the provided data.
`void`	`unassignGroupFromUser(java.lang.String pGroupName, java.lang.String pUserName)` Unassigns Group from User with the provided data.
`void`	`updateBranch(java.lang.Long pProjectId, java.lang.Long pBranchId, ProjectStreamPojo pBranch)` Updates a FlexDeploy Branch on a given project.
`CredentialDataObject`	`updateCredential(CredentialDataObject pCredentialDataObject)` Update Credential with the provided data.
`EndpointDataObject`	`updateEndpoint(EndpointDataObject pEndpointDataObject)` Update Endpoint based on the Endpoint details.
`EnvironmentDataObject`	`updateEnvironment(EnvironmentDataObject pEnvDataObject)` Update Environment based on the Environment details.
`FlxWorkItemFieldDataObject`	`updateFlxWorkItemField(FlxWorkItemFieldDataObject pDobj)` Updates Flex work item field based on the Flex work item field details.
`PropertyKeyGroupDataObject`	`updateFlxWorkItemFieldGroup(PropertyKeyGroupDataObject pDobj)` Updates Flex work item field group based on the Flex work item field group details.
`FolderDataObject`	`updateFolder(FolderDataObject pFolderDataObject)` Update Folder based on the Folder details.
`FdGroupDataObject`	`updateGroup(FdGroupDataObject pGroupDataObject)` Update Group based on the Group details.
`void`	`updatePackage(java.lang.Long pProjectId, java.lang.String pPackageName, java.lang.Long pStreamId, PollingResult pPollingResult)` Updates a given package relative to a PollingResult.
`void`	`updatePackage(java.lang.Long pProjectId, java.lang.String pPackageName, java.lang.Long pStreamId, PollingResult pPollingResult, boolean pSortFiles)` Updates a given package relative to a PollingResult.
`void`	`updatePackageStatus(java.lang.Long pProjectId, java.lang.String pPackageName, java.lang.String pPackageStatus)` Updates a given package status.
`java.lang.Long`	`updateProject(java.lang.Long pProjectId, ProjectPojo pProjectPojo)` Updates a project with the provided data.
`java.lang.Long`	`updateProjectProperties(java.lang.Long pProjectId, java.util.List<PropertyValuePojo> pPropertyPojos)` Updates a project's properties with the provided data.
`ProjectTriggerDataObject`	`updateProjectTrigger(ProjectTriggerDataObject pPojo)` Updates Project Trigger based on the project trigger details.
`PropertyKeyDefinitionDataObject`	`updatePropertyKeyDefinition(PropertyKeyDefinitionDataObject pPojo)` Updates a property key definition with the provided data.
`void`	`updateScanResult(java.lang.Long pProjectId, java.lang.String pScanId, ScanResultPojo pScanResultPojo, boolean pIsStatusSuccess)` Updates a FlexDeploy ScanResult on a given project.
`java.lang.Long`	`updateSCMInstance(java.lang.Long pSCMInstanceId, SCMInstancePojo pSCMInstancePojo)` Updates an SCM instance with the given data.
`java.lang.Long`	`updateSCMInstance(java.lang.Long pSCMInstanceId, java.lang.String pSCMInstanceName, java.lang.String pDescription, java.lang.Boolean pIsActive, java.lang.String pInstanceCode, java.util.List<PropertyValuePojo> pProperties, java.lang.String pSCMType)` Updates an SCM instance with the given data.
`void`	`updateStream(java.lang.Long pProjectId, java.lang.Long pStreamId, ProjectStreamPojo pStream)` Updates a FlexDeploy Stream on a given project.
`TargetGroupDataObject`	`updateTargetGroup(TargetGroupDataObject pTargetGroupDataObj)` Update TargetGroup based on the TargetGroup details.
`FdUserDataObject`	`updateUser(FdUserDataObject pUserDataObject)` Update User based on the User details.
`PropertySetDataObject`	`updateWorkflowPropertySet(PropertySetDataObject pPropertySet)` Updates a property set with the provided data.
`FlxWorkItemDataObject`	`updateWorkItem(FlxWorkItemDataObject pPojo)` Updates work item based on the work item details.
`FlxWorkItemDataObject`	`updateWorkItemAssignee(java.lang.String pWorkItemNumber, java.lang.String pUserName)` Updates a work item Assignee.
`FlxWorkItemDataObject`	`updateWorkItemStatus(java.lang.String pWorkItemNumber, java.lang.String pStatusName)` Updates a work item status.
`FlxWorkItemDataObject`	`updateWorkItemType(java.lang.String pWorkItemNumber, java.lang.String pTypeCode)` Updates a work item Type.

- Method Detail
  - findLocalChangeLogs
```
PollingResult findLocalChangeLogs(java.lang.String pUrl,
                                  java.lang.String pBranch,
                                  java.lang.String pCurrentRevision,
                                  java.lang.String pFromRevision)
                           throws FlexCheckedException
```
    Finds change logs for a local ssh enabled git repository. This can be used as a replacement for the getChangeLogs functions if your git provider doesn't have a specific function. If fromRevision is null it will return an empty PollingResult object. If your repository is not ssh enabled see findLocalChangeLogs
    
    Parameters:
    
    pUrl - Url of the git repository to find logs against
    
    pBranch - Branch to find logs against
    
    pCurrentRevision - Current revision after the push
    
    pFromRevision - Previous revision before the push
    
    Returns:
    
    PollingResult object containing the change logs found.
    
    Throws:
    
    FlexDeployValidationException - if an invalid revision is passed.
    
    FlexCheckedException
    
    Since:
    
    5.3.0.1
  - findLocalChangeLogs
```
PollingResult findLocalChangeLogs(java.lang.String pUrl,
                                  java.lang.String pBranch,
                                  java.lang.String pCurrentRevision,
                                  java.lang.String pFromRevision,
                                  boolean pIgnoreTargetBranchMerge)
                           throws FlexCheckedException
```
    Finds change logs for a local ssh enabled git repository. This can be used as a replacement for the getChangeLogs functions if your git provider doesn't have a specific function. If fromRevision is null it will return an empty PollingResult object. If your repository is not ssh enabled see findLocalChangeLogs
    
    Parameters:
    
    pUrl - Url of the git repository to find logs against
    
    pBranch - Branch to find logs against
    
    pCurrentRevision - Current revision after the push
    
    pFromRevision - Previous revision before the push
    
    pIgnoreTargetBranchMerge - Exclude commits that were merged from the target branch into this branch. When using git flow this will ignore merges done from the target branch 'develop' into your feature branch. Default value is true
    
    Returns:
    
    PollingResult object containing the change logs found.
    
    Throws:
    
    FlexDeployValidationException - if an invalid revision is passed.
    
    FlexCheckedException
    
    Since:
    
    5.3.0.3
  - findLocalChangeLogs
```
PollingResult findLocalChangeLogs(java.lang.String pUrl,
                                  java.lang.String pBranch,
                                  java.lang.String pCurrentRevision,
                                  java.lang.String pFromRevision,
                                  java.lang.String pUser,
                                  java.lang.String pPassword)
                           throws FlexCheckedException
```
    Finds change logs for a local git repository. This can be used as a replacement for the getChangeLogs functions if your git provider doesn't have a specific function. If fromRevision is null it will return an empty PollingResult object
    
    Parameters:
    
    pUrl - Url of the git repository to find logs against
    
    pBranch - Branch to find logs against
    
    pCurrentRevision - Current revision after the push
    
    pFromRevision - Previous revision before the push
    
    pUser - User to use for local credentials
    
    pPassword - Password of the user
    
    Returns:
    
    PollingResult object containing the change logs found.
    
    Throws:
    
    FlexDeployValidationException - if an invalid revision is passed.
    
    FlexCheckedException
    
    Since:
    
    5.3.0.1
  - findLocalChangeLogs
```
PollingResult findLocalChangeLogs(java.lang.String pUrl,
                                  java.lang.String pBranch,
                                  java.lang.String pCurrentRevision,
                                  java.lang.String pFromRevision,
                                  java.lang.String pUser,
                                  java.lang.String pPassword,
                                  boolean pIgnoreTargetBranchMerge)
                           throws FlexCheckedException
```
    Finds change logs for a local ssh enabled git repository. This can be used as a replacement for the getChangeLogs functions if your git provider doesn't have a specific function. If fromRevision is null it will return an empty PollingResult object. If your repository is not ssh enabled see findLocalChangeLogs
    
    Parameters:
    
    pUrl - Url of the git repository to find logs against
    
    pBranch - Branch to find logs against
    
    pCurrentRevision - Current revision after the push
    
    pFromRevision - Previous revision before the push
    
    pUser - User to use for local credentials
    
    pPassword - Password of the user
    
    pIgnoreTargetBranchMerge - Exclude commits that were merged from the target branch into this branch. When using git flow this will ignore merges done from the target branch 'develop' into your feature branch. Default value is true
    
    Returns:
    
    PollingResult object containing the change logs found.
    
    Throws:
    
    FlexDeployValidationException - if an invalid revision is passed.
    
    FlexCheckedException
    
    Since:
    
    5.3.0.3
  - getProject
```
ProjectPojo getProject(java.lang.Long pProjectId)
                throws FlexDeployRowNotFoundException
```
    Returns project information for a given projectId.
    
    Parameters:
    
    pProjectId - Project Id of the project to retrieve
    
    Returns:
    
    Object containing meta data about the given project
    
    Throws:
    
    FlexDeployRowNotFoundException - if no project is found for given pProjectId
    
    Since:
    
    5.3.0.1
  - createProject
```
java.lang.Long createProject(ProjectPojo pProjectPojo)
```
    Creates and configures a project with the provided data. Returns the Id of the project after creation.
    
    Parameters:
    
    pProjectPojo - - Object containing project configuration information.
    
    Returns:
    
    Id of the created project
    
    Since:
    
    5.4.0.1
  - updateProject
```
java.lang.Long updateProject(java.lang.Long pProjectId,
                             ProjectPojo pProjectPojo)
```
    Updates a project with the provided data.
    
    Parameters:
    
    pProjectId - - Id of the project that is to be updated.
    
    pProjectPojo- - Object containing project configuration information.
    
    Returns:
    
    Id of the updated project.
    
    Throws:
    
    FlexDeployRowNotFoundException - if pProjectIddoes not exist.
    
    Since:
    
    5.4.0.1
  - patchProject
```
java.lang.Long patchProject(java.lang.Long pProjectId,
                            ProjectPojo pProjectPojo)
```
    Updates a project with the provided data. This will only update fields that are passed in the pojo. Returns the Id of the project after updating.
    
    Parameters:
    
    pProjectId - - Id of the project that is to be updated.
    
    pProjectPojo- - Object containing project configuration information.
    
    Returns:
    
    Id of the updated project.
    
    Throws:
    
    FlexDeployRowNotFoundException - if pProjectIddoes not exist.
    
    Since:
    
    5.4.0.1
  - updateProjectProperties
```
java.lang.Long updateProjectProperties(java.lang.Long pProjectId,
                                       java.util.List<PropertyValuePojo> pPropertyPojos)
```
    Updates a project's properties with the provided data. This will only update properties that are passed in the list. Returns the Id of the project after updating.
    
    Parameters:
    
    pProjectId - - Id of the project that is to be updated.
    
    pPropertyPojos - - List of property values to be updated on project.
    
    Returns:
    
    Id of the updated project.
    
    Since:
    
    5.4.0.1
  - patchProjectProperties
```
java.lang.Long patchProjectProperties(java.lang.Long pProjectId,
                                      java.util.List<PropertyValuePojo> pPropertyPojos)
```
    Updates a project's properties with the provided data. This will only update properties that are passed in the list.
    
    Parameters:
    
    pProjectId - - Id of the project that is to be updated.
    
    pPropertyPojos - - List of property values to be updated on project.
    
    Returns:
    
    Id of the updated project.
    
    Since:
    
    5.4.0.1
  - addFilesToPackage
```
void addFilesToPackage(java.lang.Long pProjectId,
                       java.lang.String pPackageName,
                       java.util.List<java.lang.String> pFiles)
                throws FlexDeployRowNotFoundException
```
    Adds files to a given package. The files should match the filepath found in the File Catalog on the project.
    
    Parameters:
    
    pProjectId - Parent project id of the package
    
    pPackageName - Name of the package
    
    pFiles - Filepaths to add to the package.
    
    Throws:
    
    FlexDeployRowNotFoundException - if pPackageNamedoes not exist on project pProjectId.
  - populateFiles
```
@Deprecated
java.lang.Integer populateFiles(java.lang.Long pProjectId,
                                            java.lang.Long pStreamId)
```
    Deprecated.
    
    Populate partial deployment files for a given project. This will automatically save populate changes so it should only be used after commands and attributes have been validated.
    
    Parameters:
    
    pProjectId - Project id to populate files for. This should be a project using partial deployment.
    
    pStreamId - Stream id to use when populating.
    
    Returns:
    
    The number of new files found during populate.
    
    Throws:
    
    FlexDeployAPIException - if it is message wrapper error.
    
    See Also:
    
    findStreamId(java.lang.Long, java.lang.String)
  - discoverFiles
```
java.lang.Integer discoverFiles(java.lang.Long pProjectId,
                                java.lang.Long pStreamId)
```
    Populate partial deployment files for a given project. This will automatically save populate changes so it should only be used after commands and attributes have been validated.
    
    Parameters:
    
    pProjectId - Project id to populate files for. This should be a project using partial deployment.
    
    pStreamId - Stream id to use when populating.
    
    Returns:
    
    The number of new files found during populate.
    
    Throws:
    
    FlexDeployAPIException - if it is message wrapper error.
    
    See Also:
    
    findStreamId(java.lang.Long, java.lang.String)
  - updatePackageStatus
```
void updatePackageStatus(java.lang.Long pProjectId,
                         java.lang.String pPackageName,
                         java.lang.String pPackageStatus)
```
    Updates a given package status.
    
    Parameters:
    
    pProjectId - Parent project id of the package
    
    pPackageName - Name of the package
    
    pPackageStatu - } The updated package status [ACTIVE, COMPLETED, or INACTIVE]
    
    Throws:
    
    FlexDeployRowNotFoundException - if pProjectIdis not found or pPackageNamedoesnt exist on project
    
    FlexDeployValidationException - if pPackageStatusis invalid
  - updatePackage
```
void updatePackage(java.lang.Long pProjectId,
                   java.lang.String pPackageName,
                   java.lang.Long pStreamId,
                   PollingResult pPollingResult)
```
    Updates a given package relative to a PollingResult. For manually adding files to a package use the addFilesToPackagemethod. This function will automatically populate files if new files are detected. Files added to this package are always added to the end of the list.
    
    Parameters:
    
    pProjectId - Parent project id of the package
    
    pPackageName - Name of the package
    
    pStreamId - Stream to use when populating files if new files are found
    
    pPollingResult - PollingResult object to use for finding differences
    
    Throws:
    
    FlexDeployRowNotFoundException - if pProjectIdis not found or pPackageNamedoesnt exist on project
    
    FlexDeployValidationException - if project other than SCM Type GIT is invalid.
    
    See Also:
    
    BitbucketFunctions.getChangeLogs(java.lang.Object, java.lang.String, java.lang.String), GithubFunctions.getChangeLogs(java.lang.Object)
  - updatePackage
```
void updatePackage(java.lang.Long pProjectId,
                   java.lang.String pPackageName,
                   java.lang.Long pStreamId,
                   PollingResult pPollingResult,
                   boolean pSortFiles)
```
    Updates a given package relative to a PollingResult. For manually adding files to a package use the addFilesToPackagemethod. This function will automatically populate files if new files are detected. The files in this package can optionally be sorted by their project files sequence number.
    
    Parameters:
    
    pProjectId - Parent project id of the package
    
    pPackageName - Name of the package
    
    pStreamId - Stream to use when populating files if new files are found
    
    pPollingResult - PollingResult object to use for finding differences
    
    pSortFiles - Sort package files after update
    
    Throws:
    
    FlexDeployRowNotFoundException - if pProjectIdis not found or pPackageNamedoesnt exist on project
    
    FlexDeployValidationException - if project other than SCM Type GIT is invalid.
    
    See Also:
    
    BitbucketFunctions.getChangeLogs(java.lang.Object, java.lang.String, java.lang.String), GithubFunctions.getChangeLogs(java.lang.Object)
  - createPackage
```
java.lang.Long createPackage(java.lang.Long pProjectId,
                             java.lang.String pPackageName,
                             java.lang.String pDescription,
                             java.util.List<java.lang.String> pFiles)
```
    Creates a package for a given project and list of files.
    
    Parameters:
    
    pProjectId - Parent project id to create package under.
    
    pPackageName - Package name to use.
    
    pDescription - Description to give the package.
    
    pFiles - List of files to add to the package. File paths should be as they appear in the File Catalog of the project.
    
    Returns:
    
    Package id
  - createDynamicPackage
```
java.lang.Long createDynamicPackage(java.lang.Long pProjectId,
                                    java.lang.String pPackageName,
                                    java.lang.String pDescription,
                                    java.lang.String pIncludePath,
                                    java.lang.String pExcludePath)
```
    Creates a dynamic package for given include and exclude path.
    
    Parameters:
    
    pProjectId - Parent project id to create package under.
    
    pPackageName - Package name to use.
    
    pDescription - Description to give the package.
    
    pIncludePath - files to be included in the package.
    
    pExcludePath - files to be excluded in the package.
    
    Returns:
    
    Package id
  - createPackage
```
java.lang.Long createPackage(java.lang.Long pProjectId,
                             java.lang.String pPackageName,
                             java.lang.String pDescription,
                             java.lang.Long pStreamId,
                             PollingResult pPollingResult)
```
    Creates a package for a given project relative to a PollingResult.
    
    Parameters:
    
    pProjectId - Parent project id of the package
    
    pPackageName - Name of the package
    
    pDescription - Description to give the package.
    
    pPollingResult - PollingResult object to use for finding differences
    
    Throws:
    
    FlexDeployRowNotFoundException - if pProjectIdis not found or pPackageNamedoesnt exist on project
    
    FlexDeployValidationException - if project pProjectIdis invalid,
    
    Since:
    
    5.5.0.3
    
    See Also:
    
    BitbucketFunctions.getChangeLogs(java.lang.Object, java.lang.String, java.lang.String), GithubFunctions.getChangeLogs(java.lang.Object)
  - deletePackage
```
void deletePackage(java.lang.Long pProjectId,
                   java.lang.String pPackageName)
```
    Deletes a project package
    
    Parameters:
    
    pProjectId - Parent project id package is under.
    
    pPackageName - Name of package to delete.
    
    Throws:
    
    FlexDeployOptimisticLockException - if another user updated or deleted row.
  - buildPackage
```
java.lang.Long buildPackage(java.lang.Long pStreamId,
                            ProjectPackagePojo projectPackage)
```
    Builds a FlexDeploy Package. This function will gather change logs and commiter information from scm. If you have this information already you can improve performance by using PollingResult variant
    
    Parameters:
    
    pStreamId - Stream to use when building package. See findStreamId.
    
    projectPackage - Wrapper object containing project id and package name to build.
    
    Returns:
    
    WorkflowRequest id
    
    Throws:
    
    FlexDeployRowNotFoundException - if pStreamIdnot found in project. if no row found for project. if default build environment not found
    
    FlexDeployValidationException - if requested project is a utility project. if requested project is not active. if no build workflow or target group mapped for the project.
  - buildPackage
```
java.lang.Long buildPackage(java.lang.Long pStreamId,
                            ProjectPackagePojo projectPackage,
                            BuildOptions pBuildOptions)
```
    Builds a FlexDeploy Package. This function will gather change logs and commiter information from scm. If you have this information already you can improve performance by using PollingResult variant
    
    Parameters:
    
    pStreamId - Stream to use when building package. See findStreamId.
    
    projectPackage - Wrapper object containing project id and package name to build.
    
    pBuildOptions - Additional build object where optional options can be set.
    
    Returns:
    
    WorkflowRequest id
    
    Throws:
    
    FlexDeployRowNotFoundException - if pStreamIdnot found in project. if no row found for project. if default build environment not found
    
    FlexDeployValidationException - if requested project is a utility project. if requested project is not active. if no build workflow or target group mapped for the project.
  - buildPackage
```
java.lang.Long buildPackage(java.lang.Long pStreamId,
                            ProjectPackagePojo projectPackage,
                            PollingResult pPollingResult)
```
    Builds a FlexDeploy Package using a PollingResult.
    
    Parameters:
    
    pStreamId - Stream to use when building package. See findStreamId.
    
    projectPackage - Wrapper object containing project id and package name to build.
    
    pPollingResult - PollingResult object containing change logs and committer information.
    
    Returns:
    
    WorkflowRequest id
    
    Throws:
    
    FlexDeployRowNotFoundException - if pStreamIdnot found in project. if no row found for project. if default build environment not found
    
    FlexDeployValidationException - if requested project is a utility project. if requested project is not active. if no build workflow or target group mapped for the project.
    
    See Also:
    
    BitbucketFunctions.getChangeLogs(java.lang.Object, java.lang.String, java.lang.String), GithubFunctions.getChangeLogs(java.lang.Object)
  - buildPackage
```
java.lang.Long buildPackage(java.lang.Long pStreamId,
                            ProjectPackagePojo projectPackage,
                            PollingResult pPollingResult,
                            BuildOptions pBuildOptions)
```
    Builds a FlexDeploy Package using a PollingResult.
    
    Parameters:
    
    pStreamId - Stream to use when building package. See findStreamId.
    
    projectPackage - Wrapper object containing project id and package name to build.
    
    pPollingResult - PollingResult object containing change logs and committer information.
    
    pBuildOptions - Additional build object where optional options can be set.
    
    Returns:
    
    WorkflowRequest id
    
    Throws:
    
    FlexDeployRowNotFoundException - if pStreamIdnot found in project. if no row found for project. if default build environment not found
    
    FlexDeployValidationException - if requested project is a utility project. if requested project is not active. if no build workflow or target group mapped for the project.
    
    See Also:
    
    BitbucketFunctions.getChangeLogs(java.lang.Object, java.lang.String, java.lang.String), GithubFunctions.getChangeLogs(java.lang.Object)
  - buildProject
```
java.lang.Long buildProject(java.lang.Long pStreamId,
                            java.lang.Long pProjectId)
```
    Builds a FlexDeploy Project. This function will gather change logs and commiter information from scm. If you have this information already you can improve performance by using PollingResult variant
    
    Parameters:
    
    pStreamId - Stream to use when building project. See findStreamId.
    
    pProjectId - Project id to build.
    
    Returns:
    
    WorkflowRequest id
    
    Throws:
    
    FlexDeployRowNotFoundException - if pStreamIdnot found in project. if no row found for project. if default build environment not found
    
    FlexDeployValidationException - if requested project is a utility project. if requested project is not active. if no build workflow or target group mapped for the project.
  - buildProject
```
java.lang.Long buildProject(java.lang.Long pStreamId,
                            java.lang.Long pProjectId,
                            BuildOptions pBuildOptions)
```
    Builds a FlexDeploy Project. This function will gather change logs and commiter information from scm. If you have this information already you can improve performance by using PollingResult variant
    
    Parameters:
    
    pStreamId - Stream to use when building project. See findStreamId.
    
    pProjectId - Project id to build.
    
    pBuildOptions - Additional build object where optional options can be set.
    
    Returns:
    
    WorkflowRequest id
    
    Throws:
    
    FlexDeployRowNotFoundException - if pStreamIdnot found in project. if no row found for project. if default build environment not found
    
    FlexDeployValidationException - if requested project is a utility project. if requested project is not active. if no build workflow or target group mapped for the project.
  - buildProject
```
java.lang.Long buildProject(java.lang.Long pStreamId,
                            java.lang.Long pProjectId,
                            PollingResult pPollingResult)
```
    Builds a FlexDeploy Project using a PollingResult.
    
    Parameters:
    
    pStreamId - Stream to use when building project. See findStreamId.
    
    pProjectId - Project id to build.
    
    pPollingResult - PollingResult object containing change logs and committer information.
    
    Returns:
    
    WorkflowRequest id
    
    Throws:
    
    FlexDeployRowNotFoundException - if pStreamIdnot found in project. if no row found for project. if default build environment not found
    
    FlexDeployValidationException - if requested project is a utility project. if requested project is not active. if no build workflow or target group mapped for the project.
    
    See Also:
    
    BitbucketFunctions.getChangeLogs(java.lang.Object, java.lang.String, java.lang.String), GithubFunctions.getChangeLogs(java.lang.Object)
  - buildProject
```
java.lang.Long buildProject(java.lang.Long pStreamId,
                            java.lang.Long pProjectId,
                            PollingResult pPollingResult,
                            BuildOptions pBuildOptions)
```
    Builds a FlexDeploy Project using a PollingResult.
    
    Parameters:
    
    pStreamId - Stream to use when building project. See findStreamId.
    
    pProjectId - Project id to build.
    
    pPollingResult - PollingResult object containing change logs and committer information.
    
    pBuildOptions - Additional build object where optional options can be set.
    
    Returns:
    
    LongWorkflowRequest id
    
    Throws:
    
    FlexDeployRowNotFoundException - if pStreamIdnot found in project. if no row found for project. if default build environment not found
    
    FlexDeployValidationException - if requested project is a utility project. if requested project is not active. if no build workflow or target group mapped for the project.
    
    See Also:
    
    BitbucketFunctions.getChangeLogs(java.lang.Object, java.lang.String, java.lang.String), GithubFunctions.getChangeLogs(java.lang.Object)
  - deployPackage
```
java.lang.Long deployPackage(java.lang.Long pProjectId,
                             java.lang.String pPackageName,
                             java.lang.String pEnvironmentCode,
                             DeployOptions pDeployOptions)
```
    Deploys a FlexDeploy Package.
    
    Parameters:
    
    pProjectId - Project id to deploy.
    
    pPackageName - Name of package
    
    pEnvironmentCode - Code of the enviornment.
    
    pDeployOptions - Additional deploy object where optional options can be set.
    
    Returns:
    
    WorkflowRequest id
    
    Throws:
    
    FlexDeployRowNotFoundException - if no row found for pProjectId. if no row found for pEnvironmentCode. if no row found for pPackageName.
    
    FlexDeployValidationException - if pEnvironmentCodeis missing. if requested project is a utility project. if requested project is not active. if no deploy workflow or target group mapped for the project. if package name given for standard project.
  - deployProject
```
java.lang.Long deployProject(java.lang.Long pProjectId,
                             java.lang.String pEnvironmentCode,
                             DeployOptions pDeployOptions)
```
    Deploys a FlexDeploy Project.
    
    Parameters:
    
    pProjectId - Project id to deploy.
    
    pEnvironmentCode - Code of the enviornment.
    
    pDeployOptions - Additional deploy object where optional options can be set.
    
    Returns:
    
    WorkflowRequest id
    
    Throws:
    
    FlexDeployRowNotFoundException - if no row found for pProjectId. if no row found for pEnvironmentCode.
    
    FlexDeployValidationException - if pEnvironmentCodeis missing. if requested project is a utility project. if requested project is not active. if no deploy workflow or target group mapped for the project.
  - findProjectsForNewBranch
```
java.util.Set<java.lang.Long> findProjectsForNewBranch(java.lang.String pRepositoryName)
```
    Finds relevant FlexDeploy Projects for a new branch event. All webhook enabled projects using this repository will be returned. This function currently only compares against Git repositories and is not compatible with other scm types.
    
    Parameters:
    
    pRepositoryName - Git repository name with the change. Name is of the form (username/repo). e.g. toddmotto/public-apis
    
    Returns:
    
    List of Project ids
    
    Since:
    
    5.3.0.1
  - findProjectsForNewBranch
```
java.util.Set<java.lang.Long> findProjectsForNewBranch(java.lang.String pRepositoryName,
                                                       PollingResult pPollingResult)
```
    Finds relevant FlexDeploy Projects for a new branch event. Only projects whose sources use the files found in the polling result will be returned. If you want to return ALL projects regardless of changed files then use findProjectsForNewBranch. This function currently only compares against Git repositories and is not compatible with other scm types.
    
    Parameters:
    
    pRepositoryName - Git repository name with the change. Name is of the form (username/repo). e.g. toddmotto/public-apis
    
    pPollingResult - PollingResult object for determining relevant projects.
    
    Returns:
    
    List of Project ids
    
    Since:
    
    5.3.0.1
    
    See Also:
    
    BitbucketFunctions.getChangeLogs(java.lang.Object, java.lang.String, java.lang.String), GithubFunctions.getChangeLogs(java.lang.Object)
  - findProjectsForChange
```
java.util.Set<java.lang.Long> findProjectsForChange(java.lang.String pRepositoryName,
                                                    java.lang.String pStreamName,
                                                    PollingResult pPollingResult)
```
    Finds relevant FlexDeploy Projects for any given PollingResult and stream. A project must have a webhook trigger configured for this stream on the CI tab in order to be found by this function. This function currently only compares against Git repositories and is not compatible with other scm types.
    
    Parameters:
    
    pRepositoryName - Git repository name with the change. Name is of the form (username/repo). e.g. toddmotto/public-apis
    
    pStreamName - Stream/branch name for which the change occurred. e.g. 'master'
    
    pPollingResult - PollingResult object for determining relevant projects.
    
    Returns:
    
    List of Project ids
    
    See Also:
    
    BitbucketFunctions.getChangeLogs(java.lang.Object, java.lang.String, java.lang.String), GithubFunctions.getChangeLogs(java.lang.Object)
  - findProjectsForChange
```
java.util.Set<java.lang.Long> findProjectsForChange(java.lang.String pRepositoryName,
                                                    java.lang.String pStreamName,
                                                    java.util.List<java.lang.String> pChangedFiles)
```
    Finds relevant FlexDeploy Projects for a list of changed files. A project must have a webhook trigger configured for this stream on the CI tab in order to be found by this function. This function currently only compares against Git repositories and is not compatible with other scm types.
    
    Parameters:
    
    pRepositoryName - Git repository name with the change. Name is of the form (username/repo). e.g. toddmotto/public-apis
    
    pStreamName - Stream/branch name for which the change occurred. e.g. 'master'
    
    pChangedFiles - List of changed files from a push event. If no files are passed then all projects using given repository will be returned.
    
    Returns:
    
    List of Project ids
    
    See Also:
    
    BitbucketFunctions.getChangeLogs(java.lang.Object, java.lang.String, java.lang.String), GithubFunctions.getChangeLogs(java.lang.Object)
  - findPackagesForChange
```
java.util.Set<ProjectPackagePojo> findPackagesForChange(java.lang.String pRepositoryName,
                                                        java.lang.String pStreamName,
                                                        PollingResult pPollingResult)
```
    Finds relevant FlexDeploy Packages for any given PollingResult. A package must have a webhook trigger configured with this stream on the CI tab in order to be found by this function. This function currently only compares against Git repositories and is not compatible with other scm types.
    
    Parameters:
    
    pRepositoryName - Git repository name with the change. Name is of the form (username/repo). e.g. toddmotto/public-apis
    
    pStreamName - Stream/branch name for which the change occurred. e.g. 'master'
    
    pPollingResult - PollingResult object for determining relevant packages.
    
    Returns:
    
    List of ProjectPackages
    
    See Also:
    
    BitbucketFunctions.getChangeLogs(java.lang.Object, java.lang.String, java.lang.String), GithubFunctions.getChangeLogs(java.lang.Object)
  - findPackagesForChange
```
java.util.Set<ProjectPackagePojo> findPackagesForChange(java.lang.String pRepositoryName,
                                                        java.lang.String pStreamName,
                                                        java.util.List<java.lang.String> pChangedFiles)
```
    Finds relevant FlexDeploy Packages for a list of changed files. A package must have a webhook trigger configured with this stream on the CI tab in order to be found by this function. This function currently only compares against Git repositories and is not compatible with other scm types.
    
    Parameters:
    
    pRepositoryName - Git repository name with the change. Name is of the form (username/repo). e.g. toddmotto/public-apis
    
    pStreamName - Stream/branch name for which the change occurred. e.g. 'master'
    
    pChangedFiles - List of changed files from a push event. If no files are passed then all packages using given repository will be returned.
    
    Returns:
    
    List of ProjectPackages
    
    See Also:
    
    BitbucketFunctions.getChangeLogs(java.lang.Object, java.lang.String, java.lang.String), GithubFunctions.getChangeLogs(java.lang.Object)
  - findProjectId
```
java.lang.Long findProjectId(java.lang.String pProjectName)
```
    Finds the FlexDeploy Project id for any given name. This will only work properly if all project names are unique.
    
    Parameters:
    
    pProjectName - Case sensitive project name to search by
    
    Returns:
    
    Project id
    
    Throws:
    
    FlexDeployRowNotFoundException - if no row found for pProjectName.
  - findProjectWithId
```
ProjectDataObject findProjectWithId(java.lang.Long pProjectId)
```
    Finds Project using Id.
    
    Parameters:
    
    pProjectId- - Id of Project to find.
    
    Returns:
    
    Throws:
    
    FlexDeployRowNotFoundException - if no row found for pProjectId.
  - findProjectsWithName
```
java.util.List<ProjectDataObject> findProjectsWithName(java.lang.String pProjectName)
```
    Finds FlexDeploy Projects for any given name
    
    Parameters:
    
    pProjectName - Case insensitive project name to search by
    
    Returns:
  - searchProjects
```
PaginatedResponse<ProjectDataObject> searchProjects(ProjectDataObject pCriteriaObject,
                                                    java.lang.Integer pLimit,
                                                    java.lang.Integer pOffset)
```
    Find Projects using criteria values provided. Results are limited by pLimit and pOffset.
    
    Parameters:
    
    pCriteriaObject -
    
    pLimit -
    
    pOffset -
    
    Returns:
  - findBranchId
```
java.lang.Long findBranchId(java.lang.Long pProjectId,
                            java.lang.String pBranchName)
```
    Finds a FlexDeploy branch id from the Branch name.
    
    Parameters:
    
    pProjectId - Project id on which the branch belongs.
    
    pBranchName - Name of the branch. e.g. 'feature/JIRA-12', 'master'.
    
    Returns:
    
    Branch id
    
    Throws:
    
    FlexDeployRowNotFoundException - if no row found for pBranchNamefor pProjectId.
  - createBranch
```
java.lang.Long createBranch(java.lang.Long pProjectId,
                            java.lang.String pBranchName,
                            java.lang.String pVersionSyntax)
```
    Create a FlexDeploy Branch on a given project. Allows custom setting of the version syntax. Useful for when a branch is created in source control.
    
    Parameters:
    
    pProjectId - Project to create the branch on.
    
    pBranchName - Branch name to create.
    
    pVersionSyntax - Version Syntax to use for the branch. For example: "1.0.mybranch." + SequenceNumber. Note that this is a groovy script and literal strings should be enclosed in quotes.
    
    Returns:
    
    branch id
    
    Since:
    
    5.3.0.1
  - createBranch
```
java.lang.Long createBranch(java.lang.Long pProjectId,
                            ProjectStreamPojo pBranch)
```
    Create a FlexDeploy Branch on a given project. Useful for when a branch is created in source control.
    
    Parameters:
    
    pProjectId - Project to create the branch on.
    
    pBranch - ProjectStreamDataObject object representing the branch to create.
    
    Returns:
    
    branch id
    
    Since:
    
    5.4.0.2
  - createBranch
```
java.lang.Long createBranch(java.lang.Long pProjectId,
                            java.lang.String pBranchName)
```
    Create a FlexDeploy Branch on a given project. The branch version syntax will default to 1.0.x.n where x is the branch name and n is the incrementing version. Useful for when a branch is created in source control.
    
    Parameters:
    
    pProjectId - Project to create the branch on.
    
    pBranchName - Branch name to create.
    
    Returns:
    
    Branch id
    
    Throws:
    
    FlexCheckedException
  - updateBranch
```
void updateBranch(java.lang.Long pProjectId,
                  java.lang.Long pBranchId,
                  ProjectStreamPojo pBranch)
```
    Updates a FlexDeploy Branch on a given project.
    
    Parameters:
    
    pProjectId - Project to create the branch on.
    
    pBranchId - Id of the branch to update.
    
    pBranch - ProjectStreamPojo object representing the branch to update.
    
    Throws:
    
    FlexDeployRowNotFoundException - if pBranchIddoes not exist for pProjectId.
    
    Since:
    
    5.4.0.2
  - patchBranch
```
void patchBranch(java.lang.Long pProjectId,
                 java.lang.Long pBranchId,
                 ProjectStreamDataObject pBranch)
```
    Patches a FlexDeploy Branch on a given project. This will apply in a patch format. Only the fields passed will be updated.
    
    Parameters:
    
    pProjectId - Project to create the branch on.
    
    pBranchId - Id of the branch to update.
    
    pBranch - ProjectStreamDataObject object representing the branch to update.
    
    Throws:
    
    FlexDeployRowNotFoundException - if pBranchIddoes not exist for pProjectId.
    
    Since:
    
    5.4.0.2
  - inactivateBranch
```
void inactivateBranch(java.lang.Long pProjectId,
                      java.lang.String pBranchName)
```
    Inactivates a project stream using AM method to patch stream
    
    Parameters:
    
    pProjectId -
    
    pBranchName -
  - activateBranch
```
void activateBranch(java.lang.Long pProjectId,
                    java.lang.String pBranchName)
             throws FlexCheckedException
```
    Active a FlexDeploy Branch on a project.
    
    Parameters:
    
    pProjectId - project id for which the branch belongs.
    
    pBranchName - Branch name to inactivate.
    
    Throws:
    
    FlexCheckedException
  - findIntegrationInstance
```
IntegrationInstancePojo findIntegrationInstance(java.lang.String pIntegrationInstanceCode,
                                                java.lang.String pType)
                                         throws FlexNotFoundException
```
    Gets an integration instance based on the code. If the code does not correspond to an integration instance it will not be returned.
    
    Parameters:
    
    pIntegrationInstanceCode - Code for the integration instace.
    
    pType - Type of the integration instance. {SCM, TEST, ITS, CMS, CLOUD, ARTIFACTREPO, CISERVER, SCANTOOL, MESSAGING, OTHERTOOLS}.
    
    Returns:
    
    Simple pojo of the Integration Instance.
    
    Throws:
    
    FlexNotFoundException - if no integration instance found for passed code.
    
    Since:
    
    5.4
  - createSCMInstance
```
java.lang.Long createSCMInstance(java.lang.String pSCMInstanceName,
                                 java.lang.String pDescription,
                                 java.lang.Boolean pIsActive,
                                 java.lang.String pInstanceCode,
                                 java.util.List<PropertyValuePojo> pProperties,
                                 java.lang.String pSCMType)
```
    Creates and configures an SCM Instance with the provided data.
    
    Parameters:
    
    pSCMInstanceName - - The unique name of the SCM instance.
    
    pDescription - - The description of the SCM instance.
    
    pIsActive - - Whether or not the SCM instance is active.
    
    pInstanceCode - - The code of the SCM instance.
    
    pProperties - - A list of objects containing the required property values for the specified SCM type. The objects must contain propertyName field as well as either propertyValue if the value is not encrypted or credentialId if the value is encrypted.
    
    pSCMType - - The SCM type of the instance. Must be a valid source control management system. Possible values are SVN, GIT, CVS, TFVC, PERF, PVCS, FILE, or NONE.
    
    Returns:
    
    Id of the created SCM instance.
    
    Throws:
    
    FlexDeployValidationException - if an invalid value is passed in pSCMInstancePojo.
    
    Since:
    
    5.4.0.1
  - createSCMInstance
```
java.lang.Long createSCMInstance(SCMInstancePojo pSCMInstancePojo)
```
    Creates and configures an SCM instance with the given data.
    
    Parameters:
    
    pSCMInstancePojo - - The object containing all of the required data for the SCM instance.
    
    Returns:
    
    The Id of the created SCM instance.
    
    Throws:
    
    FlexDeployValidationException - if an invalid value is passed in pSCMInstancePojo.
    
    Since:
    
    5.4.0.1
  - updateSCMInstance
```
java.lang.Long updateSCMInstance(java.lang.Long pSCMInstanceId,
                                 java.lang.String pSCMInstanceName,
                                 java.lang.String pDescription,
                                 java.lang.Boolean pIsActive,
                                 java.lang.String pInstanceCode,
                                 java.util.List<PropertyValuePojo> pProperties,
                                 java.lang.String pSCMType)
```
    Updates an SCM instance with the given data. Returns the Id of the SCM instance after updating. If a value is left null the attribute will not be updated.
    
    Parameters:
    
    pSCMInstanceId - - The Id of the instance to be updated.
    
    pSCMInstanceName - - The unique name of the SCM instance.
    
    pDescription - - The description of the SCM instance.
    
    pIsActive - - Whether or not the SCM instance is active.",
    
    pInstanceCode - - The code of the SCM instance.
    
    pProperties - - A list of objects containing the required property values for the specified SCM type. The objects must contain propertyName field as well as either propertyValue if the value is not encrypted or credentialId if the value is encrypted.
    
    pSCMType - - The SCM type of the instance. Must be a valid source control management system. Possible values are SVN, GIT, CVS, TFVC, PERF, PVCS, FILE, or NONE.
    
    Returns:
    
    The Id of the updated SCM Instance
    
    Throws:
    
    FlexDeployValidationException - if an invalid value is passed in pSCMInstancePojo.
    
    Since:
    
    5.4.0.1
  - updateSCMInstance
```
java.lang.Long updateSCMInstance(java.lang.Long pSCMInstanceId,
                                 SCMInstancePojo pSCMInstancePojo)
```
    Updates an SCM instance with the given data. Returns the Id of the SCM instance after updating. If a value is left null the attribute will not be updated.
    
    Parameters:
    
    pSCMInstanceId - - The Id of the instance to be updated.
    
    pSCMInstancePojo - - Object containing all of the required data for the SCM instance.
    
    Returns:
    
    The Id of the updated SCM instance.
    
    Throws:
    
    FlexDeployValidationException - if an invalid value is passed in pSCMInstancePojo.
    
    Since:
    
    5.4.0.1
  - getIntegrationInstance
```
IntegrationInstancePojo getIntegrationInstance(java.lang.Long pIntegrationInstanceId,
                                               java.lang.String pType)
```
    Gets an integration instance based on the id. If the id does not correspond to an integration instance it will not be returned.
    
    Parameters:
    
    pIntegrationInstanceId - Integration Instance id.
    
    pType - Type of the integration instance. {SCM, TEST, ITS, CMS, CLOUD, ARTIFACTREPO, CISERVER, SCANTOOL, MESSAGING, OTHERTOOLS}.
    
    Returns:
    
    Simple pojo of the Integration Instance.
    
    Throws:
    
    FlexDeployRowNotFoundException - if no integration instance found for pIntegrationInstanceId.
    
    Since:
    
    5.4
  - findCMSInstance
```
CMSInstancePojo findCMSInstance(java.lang.String pCMSInstanceCode)
```
    Gets a CMSInstance based on the CMS Instance Code passed. This method returns a simple object containing the metadata of the cms instance.
    
    Parameters:
    
    pCMSInstanceCode - Code of the instance you wish to retrieve.
    
    Returns:
    
    Simple pojo of the CMS Instance.
    
    Throws:
    
    FlexDeployRowNotFoundException - if no instance found for pCMSInstanceCode.
    
    Since:
    
    5.4
  - getCMSInstance
```
CMSInstancePojo getCMSInstance(java.lang.Long pCMSInstanceId)
```
    Gets a CMSInstance based on the CMS Instance Id passed. This method returns a simple object containing the metadata of the cms instance.
    
    Parameters:
    
    pCMSInstanceId - Id of the instance you wish to retrieve.
    
    Returns:
    
    Simple pojo of the CMS Instance.
    
    Throws:
    
    FlexDeployRowNotFoundException - if no instance found for pCMSInstanceId.
    
    Since:
    
    5.4
  - getChangeManagementSystemByInstanceCode
```
ChangeManagementSystem getChangeManagementSystemByInstanceCode(java.lang.String pInstanceCode)
```
    Returns a CMS System for a particular CMS Instance by searching with Instance Code.
    
    Parameters:
    
    pInstanceCode - Instance code to filter by.
    
    Returns:
    
    ChangeManagementSystem implementation.
    
    Throws:
    
    FlexDeployRowNotFoundException - If no CMS instance was found given pCode.
  - getChangeManagementSystemByInstanceName
```
ChangeManagementSystem getChangeManagementSystemByInstanceName(java.lang.String pInstanceName)
```
    Returns a CMS System for a particular CMS Instance by searching with Instance Name.
    
    Parameters:
    
    pInstanceName - Instance name to filter by.
    
    Returns:
    
    ChangeManagementSystem implementation.
    
    Throws:
    
    FlexDeployRowNotFoundException - If no CMS instance was found given pName.
  - createIncidentForWorklowRequest
```
CMSObject createIncidentForWorklowRequest(java.lang.Long pWorkflowRequestId,
                                          java.util.Map<java.lang.String,java.io.Serializable> pIncidentFields,
                                          java.lang.String pCMSInstanceCode,
                                          java.lang.String pCMSInstanceName)
```
    Returns a CMSObject with incident details for a particular CMS Instance by searching with Instance Name and Instance Code. Null can be passed for code or name if you do not wish to filter by that argument. You can execute all available functions used internally such as createRequest and createIncident.
    
    Parameters:
    
    pWorkflowRequestId - Associated workflow request id .
    
    pIncidentFields - Payload fields populated with key value to create an Incident.
    
    pCode - Instance code to filter by.
    
    pName - Instance name to filter by.
    
    Returns:
    
    CMSObject Incident details.
  - createIncidentByWorkflowType
```
CMSObject createIncidentByWorkflowType(java.lang.Long pWorkflowRequestId,
                                       java.util.Map<java.lang.String,java.io.Serializable> pIncidentFields)
```
    Returns a CMSObject with incident details. This method creates incident if project's folder has an extenal approval configured for the workflow type and environment.
    
    Parameters:
    
    pWorkflowRequestId - Associated workflow request id .
    
    pIncidentFields - Payload fields populated with key value to create an Incident.
    
    Returns:
    
    CMSObject Incident details.
  - getChangeManagementSystemByInstanceId
```
ChangeManagementSystem getChangeManagementSystemByInstanceId(java.lang.Long pCMSInstanceId)
```
    Returns a CMS System for a particular CMS Instance Id. The instance allows direct integration with the change management system and includes functions such as createTicket and createIncident.
    
    Parameters:
    
    pCMSInstanceId - Instance id of the implementation you wish to retrieve.
    
    Returns:
    
    ChangeManagementSystem implementation
    
    Throws:
    
    FlexDeployRowNotFoundException - If no instance found for pCMSInstanceId.
  - getUsersFromGroupId
```
java.util.List<FDUser> getUsersFromGroupId(java.lang.Long pGroupId)
```
    Gets a list of FDUser objects that are members of the group with the given group Id.
    
    Parameters:
    
    pGroupId - FlexDeploy Group id to use.
    
    Returns:
    
    List of FDUser objects.
    
    Since:
    
    5.4
  - downloadLogs
```
void downloadLogs(java.lang.Long pWorkflowExecutionId,
                  java.lang.String pDestinationPath)
```
    Downloads the plugin logs from the workflow execution based on Id. The logs will be saved in order of execution to the specified path in a folder named after the workflow execution Id.
    
    Parameters:
    
    pWorkflowExecutionId - Workflow Execution Id to capture logs for.
    
    pDestinationPath - The path where the log files folder will be saved.
    
    Throws:
    
    FlexDeployValidationException - if pDestinationPathis not provided.
    
    Since:
    
    5.4
  - getPluginLogInputStreams
```
java.util.Map<java.lang.Long,java.io.InputStream> getPluginLogInputStreams(java.lang.Long pWorkflowExecutionId)
```
    Returns plugin logs from a workflow execution as a map with the key being the plugin execution id and value as an InputStream of log data.
    
    Parameters:
    
    pWorkflowExecutionId - Workflow Execution Id to capture logs for.
    
    Since:
    
    5.4
  - getPluginLogInputStreams
```
java.util.Map<java.lang.Long,java.io.InputStream> getPluginLogInputStreams(java.lang.Long pWorkflowExecutionId,
                                                                           java.lang.Boolean pOnlyError)
```
    Returns plugin logs from a workflow execution as a map with the key being the plugin execution id and value as an InputStream of log data.
    
    Parameters:
    
    pWorkflowExecutionId - Workflow Execution Id to capture logs for.
    
    pOnlyError - Return only the failed plugin log input stream, otherwise all plugin logs for the workflow will be returned.
    
    Throws:
    
    FlexCheckedException
    
    Since:
    
    5.4
  - getPackage
```
PackageDetailsResponsePojo getPackage(java.lang.Long pProjectId,
                                      java.lang.String pPackageName)
```
    Returns a PackageDetailsResponsePojo given a Project Id and Package Name
    
    Parameters:
    
    pProjectId - Parent project id package is under.
    
    pPackageName - Name of package
    
    Returns:
    
    PackageDetailsResponsePojo
    
    Throws:
    
    FlexDeployRowNotFoundException - If no project package found for pProjectIdand pPackageName.
    
    Since:
    
    5.5.0.3
  - getPluginLogs
```
java.util.Collection<PluginLogPojo> getPluginLogs(java.lang.Long pWorkflowExecutionId)
```
    Gets the plugin logs from the workflow execution based on Id.
    
    Parameters:
    
    pWorkflowExecutionId - Workflow Execution Id to capture logs for.
    
    Returns:
    
    A collection, one per plugin execution, of PluginLogPojos.
    
    Since:
    
    5.4
  - getFlexDeployBaseUrl
```
java.lang.String getFlexDeployBaseUrl()
```
    Returns the FlexDeploy Server base url configured in System Settings.
    
    Returns:
    
    The base url of the current FlexDeploy service.
    
    Since:
    
    5.4
  - executeUtility
```
java.lang.Long executeUtility(java.lang.Long pProjectId,
                              java.lang.String pEnvironmentCode)
```
    Executes a FlexDeploy Utility Project for a single environment on all instances configured in Project Configuration.
    
    Parameters:
    
    pProjectId - Project id to execute.
    
    pEnvironmentCode - Environment code to use for the utility request.
    
    Returns:
    
    WorkflowRequest id
    
    Throws:
    
    FlexDeployValidationException - if pEnvironmentCodeis not provided.
  - executeUtility
```
java.lang.Long executeUtility(java.lang.Long pProjectId,
                              java.lang.String pEnvironmentCode,
                              ExecuteOptions pExecuteOptions)
```
    Executes a FlexDeploy Utility Project for a single environment with specified ExecuteOptions. If instance codes are not passed in the ExecuteOptions, then the project will get executed on all instances associated to the passed environment.
    
    Parameters:
    
    pProjectId - Project id to execute.
    
    pEnvironmentCode - Environment code to use for the utility request.
    
    pInstanceCode - Instance code to use for the utility request.
    
    pExecuteOptions - Execute options contains list of instances to execute on, with inputs and flexfields
    
    Returns:
    
    WorkflowRequest id
    
    Throws:
    
    FlexDeployValidationException - if pEnvironmentCodeis not provided.
  - findFolderId
```
java.lang.Long findFolderId(java.lang.String pFolderName)
```
    Finds the FlexDeploy Folder id for any given name. This will only work properly if all Folder Names are unique.
    
    Parameters:
    
    pFolderName - Case sensitive folder name to search by
    
    Returns:
    
    Folder id
    
    Throws:
    
    FlexDeployRowNotFoundException - If folder name is not found in FlexDeploy
  - findFolderWithId
```
FolderDataObject findFolderWithId(java.lang.Long pFolderId)
```
    Finds Folder using Id.
    
    Parameters:
    
    pFolderId -
    
    Returns:
  - findFoldersWithName
```
java.util.List<FolderDataObject> findFoldersWithName(java.lang.String pFolderName)
```
    Finds FlexDeploy Folders for any given name
    
    Parameters:
    
    pFolderName - Case insensitive project name to search by
    
    Returns:
  - searchFolders
```
PaginatedResponse<FolderDataObject> searchFolders(FolderDataObject pCriteriaObject,
                                                  java.lang.Integer pLimit,
                                                  java.lang.Integer pOffset)
```
    Find Folders using criteria values provided. Results are limited by pLimit and pOffset.
    
    Parameters:
    
    pCriteriaObject -
    
    pLimit -
    
    pOffset -
    
    Returns:
  - searchBranches
```
PaginatedResponse<ProjectStreamDataObject> searchBranches(ProjectStreamDataObject pCriteriaObject,
                                                          java.lang.Integer pLimit,
                                                          java.lang.Integer pOffset)
```
    Find Branches using criteria values provided. Results are limited by pLimit and pOffset.
    
    Parameters:
    
    pCriteriaObject -
    
    pLimit -
    
    pOffset -
    
    Returns:
  - getUser
```
FdUserDataObject getUser(java.lang.String pUsername)
```
    Returns user information for a given username.
    
    Parameters:
    
    pUsername - - Username of the user to retrieve.
    
    Returns:
    
    Object containing basic information for given user if user exists.
    
    Since:
    
    5.7.0.2
  - getCurrentlyDeployedVersionId
```
java.lang.Long getCurrentlyDeployedVersionId(java.lang.Long pProjectId,
                                             java.lang.Long pEnvironmentId,
                                             java.lang.Long pInstanceId)
```
    Returns currently deployed project version Id of full deployment project.
    
    Parameters:
    
    pProjectId - Project Id of the project to retrieve.
    
    pEnvironmentId - - Id of the enviornment.
    
    pInstanceId - - Id of the instance.
    
    Returns:
    
    currently deployed project version Id.
  - getCurrentlyDeployedVersionId
```
java.lang.Long getCurrentlyDeployedVersionId(java.lang.Long pProjectId,
                                             java.lang.Long pEnvironmentId,
                                             java.lang.Long pInstanceId,
                                             java.lang.String pPackageName)
```
    Returns currently deployed project version Id of partial deployment project.
    
    Parameters:
    
    pProjectId - Project Id of the project to retrieve.
    
    pEnvironmentId - - Id of the enviornment.
    
    pInstanceId - - Id of the instance.
    
    pPackageName - - Name of the package.
    
    Returns:
    
    currently deployed project version Id.
    
    Throws:
    
    FlexDeployValidationException - if pPackageNameis not provided.
  - getPreviouslyDeployedVersionId
```
java.lang.Long getPreviouslyDeployedVersionId(java.lang.Long pProjectId,
                                              java.lang.Long pEnvironmentId,
                                              java.lang.Long pInstanceId)
```
    Returns previously deployed project version Id of full deployment project.
    
    Parameters:
    
    pProjectId - Project Id of the project to retrieve.
    
    pEnvironmentId - - Id of the enviornment.
    
    pInstanceId - - Id of the instance.
    
    Returns:
    
    previoulsy deployed project version Id.
  - getPreviouslyDeployedVersionId
```
java.lang.Long getPreviouslyDeployedVersionId(java.lang.Long pProjectId,
                                              java.lang.Long pEnvironmentId,
                                              java.lang.Long pInstanceId,
                                              java.lang.String pPackageName)
```
    Returns previously deployed project version Id of partial deployment project.
    
    Parameters:
    
    pProjectId - Project Id of the project to retrieve.
    
    pEnvironmentId - - Id of the enviornment.
    
    pInstanceId - - Id of the instance.
    
    pPackageName - - Name of the package.
    
    Returns:
    
    previously deployed project version Id.
    
    Throws:
    
    FlexDeployValidationException - if pPackageNameis not provided.
  - createStream
```
java.lang.Long createStream(java.lang.Long pProjectId,
                            ProjectStreamPojo pStream)
```
    Create a FlexDeploy Stream on a given project. Useful for when a branch is created in source control.
    
    Parameters:
    
    pProjectId - Project to create the stream on.
    
    pStream - ProjectStreamDataObject object representing the stream to create.
    
    Returns:
    
    Stream id
    
    Since:
    
    5.4.0.2
  - createStream
```
java.lang.Long createStream(java.lang.Long pProjectId,
                            java.lang.String pStreamName)
```
    Create a FlexDeploy Stream on a given project. The stream version syntax will default to 1.0.x.n where x is the stream name and n is the incrementing version. Useful for when a branch is created in source control.
    
    Parameters:
    
    pProjectId - Project to create the stream on.
    
    pStreamName - Stream name to create.
    
    Returns:
    
    Stream id
    
    Throws:
    
    FlexCheckedException
  - createStream
```
java.lang.Long createStream(java.lang.Long pProjectId,
                            java.lang.String pStreamName,
                            java.lang.String pVersionSyntax)
```
    Create a FlexDeploy Stream on a given project. Allows custom setting of the version syntax. Useful for when a branch is created in source control.
    
    Parameters:
    
    pProjectId - Project to create the stream on.
    
    pStreamName - Stream name to create.
    
    pVersionSyntax - Version Syntax to use for the stream. For example: "1.0.mybranch." + SequenceNumber. Note that this is a groovy script and literal strings should be enclosed in quotes.
    
    Returns:
    
    Stream id
    
    Since:
    
    5.3.0.1
  - findStreamId
```
java.lang.Long findStreamId(java.lang.Long pProjectId,
                            java.lang.String pStreamName)
```
    Finds a FlexDeploy stream id from the Stream name.
    
    Parameters:
    
    pProjectId - Project id on which the stream belongs.
    
    pStreamName - Name of the stream. e.g. 'feature/JIRA-12', 'master'.
    
    Returns:
    
    Stream id
    
    Throws:
    
    FlexDeployRowNotFoundException - if no row found for pStreamNamefor pProjectId.
  - inactivateStream
```
void inactivateStream(java.lang.Long pProjectId,
                      java.lang.String pStreamName)
```
    Inactivates a project stream using AM method to patch stream
    
    Parameters:
    
    pProjectId -
    
    pStreamName -
  - activateStream
```
void activateStream(java.lang.Long pProjectId,
                    java.lang.String pStreamName)
             throws FlexCheckedException
```
    Active a FlexDeploy Stream on a project.
    
    Parameters:
    
    pProjectId - project id for which the stream belongs.
    
    pStreamName - Stream name to inactivate.
    
    Throws:
    
    FlexCheckedException
  - patchStream
```
void patchStream(java.lang.Long pProjectId,
                 java.lang.Long pStreamId,
                 ProjectStreamDataObject pStream)
```
    Patches a FlexDeploy Stream on a given project. This will apply in a patch format. Only the fields passed will be updated.
    
    Parameters:
    
    pProjectId - Project to create the stream on.
    
    pStreamId - Id of the stream to update.
    
    pStream - ProjectStreamDataObject object representing the stream to update.
    
    Throws:
    
    FlexDeployRowNotFoundException - if pStreamIddoes not exist for pProjectId.
    
    Since:
    
    5.4.0.2
  - updateStream
```
void updateStream(java.lang.Long pProjectId,
                  java.lang.Long pStreamId,
                  ProjectStreamPojo pStream)
```
    Updates a FlexDeploy Stream on a given project.
    
    Parameters:
    
    pProjectId - Project to create the stream on.
    
    pStreamId - Id of the stream to update.
    
    pStream - ProjectStreamPojo object representing the stream to update.
    
    Throws:
    
    FlexDeployRowNotFoundException - if pStreamIddoes not exist for pProjectId.
    
    Since:
    
    5.4.0.2
  - updateScanResult
```
void updateScanResult(java.lang.Long pProjectId,
                      java.lang.String pScanId,
                      ScanResultPojo pScanResultPojo,
                      boolean pIsStatusSuccess)
```
    Updates a FlexDeploy ScanResult on a given project.
    
    Parameters:
    
    pProjectId - Project to update the scan results.
    
    pScanId - Id of the scan result to update.
    
    pScanResultPojo - ScanResultPojo object representing the scanResult to update.
    
    pIsStatusSuccess - is scan status success or not.
    
    Since:
    
    6.0
  - getScanResultForSonarqube
```
ScanResultPojo getScanResultForSonarqube(java.lang.String pBaseUrl,
                                         java.lang.String pProjectKey)
                                  throws FlexCheckedException
```
    get Scan result for SonarQube
    
    Parameters:
    
    pBaseUrl -
    
    pProjectKey -
    
    Returns:
    
    ScanResultPojo
    
    Throws:
    
    FlexCheckedException
    
    Since:
    
    6.0
  - getIssueTrackingSystemByInstanceCode
```
IssueTrackingSystem getIssueTrackingSystemByInstanceCode(java.lang.String pInstanceCode)
```
    Returns a ITS System for a particular ITS Instance Code. The instance allows direct integration with the issue tracking system and includes functions such as getTicketStatus, getTicketURL.
    
    Parameters:
    
    pInstanceCode - Instance code of the implementation you wish to retrieve.
    
    Returns:
    
    IssueTrackingSystem implementation
    
    Throws:
    
    FlexDeployRowNotFoundException - If no instance found for pInstanceCode.
  - getIssueTrackingSystemByInstanceName
```
IssueTrackingSystem getIssueTrackingSystemByInstanceName(java.lang.String pInstanceName)
```
    Returns a ITS System for a particular ITS Instance Name. The instance allows direct integration with the issue tracking system and includes functions such as getTicketStatus, getTicketURL.
    
    Parameters:
    
    pInstanceName - Instance Name of the implementation you wish to retrieve.
    
    Returns:
    
    IssueTrackingSystem implementation
    
    Throws:
    
    FlexDeployRowNotFoundException - If no instance found for pInstanceName.
  - getIssueTrackingSystemByInstanceId
```
IssueTrackingSystem getIssueTrackingSystemByInstanceId(java.lang.Long pITSInstanceId)
```
    Returns a ITS System for a particular ITS Instance Id. The instance allows direct integration with the issue tracking system and includes functions such as getTicketStatus, getTicketURL.
    
    Parameters:
    
    pITSInstanceId - Instance id of the implementation you wish to retrieve.
    
    Returns:
    
    IssueTrackingSystem implementation
    
    Throws:
    
    FlexDeployRowNotFoundException - If no instance found for pITSInstanceId.
  - getMatchingProjectObjectId
```
java.lang.Long getMatchingProjectObjectId(java.lang.Long pProjectId,
                                          java.lang.String pFile)
```
    Returns internal id for file in a project. File is path represented on File Catalog.
    
    Parameters:
    
    pProjectId -
    
    pFile -
    
    Returns:
  - searchProjectPackages
```
PaginatedResponse<ProjectPackageDataObject> searchProjectPackages(ProjectPackageDataObject pCriteriaObject,
                                                                  java.lang.Integer pLimit,
                                                                  java.lang.Integer pOffset)
```
    Find Packages using criteria values provided. Results are limited by pLimit and pOffset.
    
    Parameters:
    
    pCriteriaObject -
    
    pLimit -
    
    pOffset -
    
    Returns:
  - searchEnvironments
```
PaginatedResponse<EnvironmentDataObject> searchEnvironments(EnvironmentDataObject pCriteriaObject,
                                                            java.lang.Integer pLimit,
                                                            java.lang.Integer pOffset)
```
    Find Environments using criteria values provided. Results are limited by pLimit and pOffset.
    
    Parameters:
    
    pCriteriaObject -
    
    pLimit -
    
    pOffset -
    
    Returns:
  - searchTargetGroups
```
PaginatedResponse<TargetGroupDataObject> searchTargetGroups(TargetGroupDataObject pCriteriaObject,
                                                            java.lang.Integer pLimit,
                                                            java.lang.Integer pOffset)
```
    Find TargetGroups using criteria values provided. Results are limited by pLimit and pOffset.
    
    Parameters:
    
    pCriteriaObject -
    
    pLimit -
    
    pOffset -
    
    Returns:
  - getEnvironmentById
```
EnvironmentDataObject getEnvironmentById(java.lang.Long pEnvironmentId)
```
    Returns Environment information for a given environment Id.
    
    Parameters:
    
    pEnvironmentId - Environment id of the Environment to retrive
    
    Returns:
    
    Object containing meta data about the given Environment
    
    Throws:
    
    FlexDeployRowNotFoundException - If Environment not found for given pEnvironmentId
  - getEnvironmentByCode
```
EnvironmentDataObject getEnvironmentByCode(java.lang.String pEnvironmentCode)
```
    Returns Environment information for a given environment code.
    
    Parameters:
    
    pEnvironmentCode - Environment code of the Environment to retrive
    
    Returns:
    
    Object containing meta data about the given Environment
    
    Throws:
    
    FlexDeployRowNotFoundException - If Environment not found for given pEnvironmentCode
  - getEnvironmentByName
```
EnvironmentDataObject getEnvironmentByName(java.lang.String pEnvironmentName)
```
    Returns Environment information for a given environmentName
    
    Parameters:
    
    pEnvironmentName - Environment name of the Environment to retrive
    
    Returns:
    
    Object containing meta data about the given Environment
    
    Throws:
    
    FlexDeployRowNotFoundException - If Environment not found for given pEnvironmentName
  - getTargetGroupById
```
TargetGroupDataObject getTargetGroupById(java.lang.Long pTargetGroupId)
```
    Get the TargetGroup based on TargetGroup id passed.
    
    Parameters:
    
    pTargetGroupId -
    
    Returns:
    
    TargetGroupDataObject
    
    Throws:
    
    FlexDeployRowNotFoundException - If TargetGroup not found for given pTargetGroupId
  - getTargetGroupByCode
```
TargetGroupDataObject getTargetGroupByCode(java.lang.String pTargetGroupCode)
```
    Get the TargetGroup based on TargetGroup code passed.
    
    Parameters:
    
    pTargetGroupCode -
    
    Returns:
    
    TargetGroupDataObject
    
    Throws:
    
    FlexDeployRowNotFoundException - If TargetGroup not found for given pTargetGroupCode
  - getTargetGroupByName
```
TargetGroupDataObject getTargetGroupByName(java.lang.String pTargetGroupName)
```
    Get the TargetGroup based on TargetGroup name passed.
    
    Parameters:
    
    pTargetGroupName -
    
    Returns:
    
    TargetGroupDataObject
    
    Throws:
    
    FlexDeployRowNotFoundException - If TargetGroup not found for given pTargetGroupName
  - findEnvironment
```
java.util.List<EnvironmentPojo> findEnvironment(java.lang.String pEnvironmentCode)
```
    Gets the environment with the specified enviornment code.
    
    Parameters:
    
    pEnvironmentCode - Code of the enviornment.
    
    Returns:
    
    A List of pojo of the environment.
    
    Throws:
    
    FlexDeployRowNotFoundException - If no environment is found for the given enviornment code
    
    Since:
    
    5.4
  - getEnvironment
```
EnvironmentPojo getEnvironment(java.lang.Long pEnvironmentId)
```
    Gets the environment with the specified Id.
    
    Parameters:
    
    pEnvironmentId - Id of the enviornment.
    
    Returns:
    
    A simple pojo of the environment.
    
    Throws:
    
    FlexDeployRowNotFoundException - If no environment is found for the given id.
    
    Since:
    
    5.4
  - getWorkflowExecutionCommits
```
java.util.List<ScmCommitDataObject> getWorkflowExecutionCommits(java.lang.Long pWorkflowExecutionId)
```
    Gets Commit details associated with workflow execution. Commits associated may be different for same Project Version deployed to two different environments, depending on what was previously deployed to those environments. Hence this method indicates which Commit were built or deployed as part of specific workflow execution.
    
    Parameters:
    
    pWorkflowExecutionId - Workflow Execution Id to retrieve associated commit details
    
    Returns:
    
    A simple pojoList of the commit details
    
    Since:
    
    6.5
  - getWorkflowExecutionWorkItems
```
java.util.List<WorkItemDataObject> getWorkflowExecutionWorkItems(java.lang.Long pWorkflowExecutionId)
```
    Gets WorkItem details associated with workflow execution. WorkItems associated may be different for same Project Version deployed to two different environments, depending on what was previously deployed to those environments. Hence this method indicates which WorkItems were built or deployed as part of specific workflow execution.
    
    Parameters:
    
    pWorkflowExecutionId - Workflow Execution Id to retrieve associated workitem details
    
    Returns:
    
    A simple pojoList of the workitem details
    
    Since:
    
    6.5
  - getWorkflowExecutionByWorkflowRequestId
```
java.util.List<WorkflowExecutionDataObject> getWorkflowExecutionByWorkflowRequestId(java.lang.Long pWorkflowRequestId)
```
    Gets workflow execution details by workflow request id.
    
    Parameters:
    
    pWorkflowRequestId - Workflow Request Id to retrieve associated workflow execution details.
    
    Returns:
    
    A simple pojoList of the workflow execution details.
    
    Since:
    
    6.5
  - getWorkflowExecutionById
```
WorkflowExecutionDataObject getWorkflowExecutionById(java.lang.Long pWorkflowExecutionId)
```
    Gets workflow execution details for workflow execution id.
    
    Parameters:
    
    pWorkflowExecutionId - Workflow Execution Id to retrieve associated workflow execution details.
    
    Returns:
    
    A simple pojoList of the workflow execution details.
    
    Throws:
    
    FlexDeployRowNotFoundException - If no workflow execution is found for the given id.
    
    Since:
    
    6.5
  - getWorkflowExecutionOutputs
```
java.util.List<CodeValueInputPOJO> getWorkflowExecutionOutputs(java.lang.Long pWorkflowExecutionId)
```
    Gets workflow execution output details for workflow execution id.
    
    Parameters:
    
    pWorkflowExecutionId - Workflow Execution Id to retrieve associated workflow execution output details.
    
    Returns:
    
    A simple pojoList of the workflow execution output details.
    
    Throws:
    
    FlexDeployRowNotFoundException
    
    Since:
    
    6.5
  - getWorkflowExecutionInputs
```
java.util.List<CodeValueInputPOJO> getWorkflowExecutionInputs(java.lang.Long pWorkflowExecutionId)
```
    Gets workflow execution inputs details for workflow execution id.
    
    Parameters:
    
    pWorkflowExecutionId - Workflow Execution Id to retrieve associated workflow execution input details.
    
    Returns:
    
    A simple pojoList of the workflow execution input details.
    
    Throws:
    
    FlexDeployRowNotFoundException
    
    Since:
    
    6.5.0.5
  - getWorkflowExecutionFlexfields
```
java.util.List<CodeValueInputPOJO> getWorkflowExecutionFlexfields(java.lang.Long pWorkflowExecutionId)
```
    Gets workflow execution flexfields details for workflow execution id.
    
    Parameters:
    
    pWorkflowExecutionId - Workflow Execution Id to retrieve associated workflow execution flexfields details.
    
    Returns:
    
    A simple pojoList of the workflow execution flexfields details.
    
    Throws:
    
    FlexDeployRowNotFoundException
    
    Since:
    
    6.5.0.5
  - getWorkflowExecutionVariables
```
WorkflowExecutionVariables getWorkflowExecutionVariables(java.lang.Long pWorkflowExecutionId)
```
    Gets workflow execution variables for workflow execution id. Return object contains inputs, outputs, flexfields, properties, etc...
    
    Parameters:
    
    pWorkflowExecutionId - Workflow Execution Id to retrieve associated workflow execution variables.
    
    Returns:
    
    A simple pojo of the workflow execution variables.
    
    Throws:
    
    FlexDeployRowNotFoundException
    
    Since:
    
    6.5.0.5
  - getActiveBuildFlexfieldMetadata
```
java.util.List<FlexFieldMetadataDataObject> getActiveBuildFlexfieldMetadata()
```
    Gets active build flexfields metadata.
    
    Returns:
    
    A simple pojoList of the active build flexfield metadata details.
    
    Since:
    
    6.5.0.5
  - getActiveDeployUtilityFlexfieldMetadata
```
java.util.List<FlexFieldMetadataDataObject> getActiveDeployUtilityFlexfieldMetadata()
```
    Gets active deploy or utility flexfields metadata.
    
    Returns:
    
    A simple pojoList of the active deploy or utility flexfield metadata details.
    
    Since:
    
    6.5.0.5
  - getProjectVersionById
```
ProjectVersionDataObject getProjectVersionById(java.lang.Long pProjectVersionId,
                                               java.lang.Long pProjectId)
```
    Gets project version data object by project version id and project Id.
    
    Parameters:
    
    pProjectVersionId - Project version Id to get the project version data object.
    
    pProjectId - Project Id to get the project version data object.
    
    Returns:
    
    A simple pojoList of the project version details.
    
    Throws:
    
    FlexDeployRowNotFoundException - If no project version is found for the given project version id and project id.
    
    Since:
    
    6.5
  - searchProjectVersions
```
PaginatedResponse<ProjectVersionDataObject> searchProjectVersions(ProjectVersionDataObject pParameters,
                                                                  java.lang.Integer pLimit,
                                                                  java.lang.Integer pOffset)
```
    Find Project Versions using criteria values provided. Results are limited by pLimit and pOffset.
    
    Parameters:
    
    pParameters - Parameters for the search criteria.
    
    pLimit - Limit for the number of rows to be returned.
    
    pOffset - offset number from which the limit starts.pass 0 to start at begining of query result.
    
    Returns:
    
    Since:
    
    6.5
  - getPipelineStageGateTasks
```
java.util.List<TasksQueryResultPojo> getPipelineStageGateTasks(java.lang.Long pPipelineStageExecId)
```
    Gets Task details based on pipeline stage execution id.
    
    Parameters:
    
    pPipelineStageExecId - pipeline stage execution id to get the Tasks details.
    
    Returns:
    
    A simple pojo list of task details.
    
    Since:
    
    6.5
  - getApprovedPipelineStageGateTasks
```
java.util.List<TasksQueryResultPojo> getApprovedPipelineStageGateTasks(java.lang.Long pPipelineStageExecId)
```
    Gets Task details based on pipeline stage execution id.
    
    Parameters:
    
    pPipelineStageExecId - pipeline stage execution id to get the Tasks details.
    
    Returns:
    
    A simple pojo list of task details.
    
    Since:
    
    6.5
  - getWorkflowRequestTasks
```
java.util.List<TasksQueryResultPojo> getWorkflowRequestTasks(java.lang.Long pWorkflowRequestId)
```
    Gets Task details based on workflow request id.
    
    Parameters:
    
    pWorkflowRequestId - Workflow Request id to get the Tasks details.
    
    Returns:
    
    A simple pojo list of task details.
    
    Since:
    
    6.5
  - createProjectTrigger
```
ProjectTriggerDataObject createProjectTrigger(ProjectTriggerDataObject pPojo)
```
    Creates a project trigger with the provided data.Returns the project trigger details after creation.
    
    Parameters:
    
    pPojo - Object containing Project trigger details to create the project trigger.
    
    Returns:
    
    A simple pojo of the project trigger details.
    
    Since:
    
    6.5
  - getProjectTriggerById
```
ProjectTriggerDataObject getProjectTriggerById(java.lang.Long pProjectTriggerId)
                                        throws FlexDeployRowNotFoundException
```
    Returns the project trigger information based on Project Trigger id.
    
    Parameters:
    
    pProjectTriggerId - Project Trigger Id to retrieve the project trigger details.
    
    Returns:
    
    A simple pojo of project trigger details.
    
    Throws:
    
    FlexDeployRowNotFoundException - If no project trigger is found for the given project trigger id
    
    Since:
    
    6.5
  - searchProjectTriggers
```
PaginatedResponse<ProjectTriggerDataObject> searchProjectTriggers(ProjectTriggerDataObject pCriteriaObject,
                                                                  java.lang.Integer pLimit,
                                                                  java.lang.Integer pOffset)
```
    Find Project Triggers using criteria values provided. Results are limited by pLimit and pOffset.
    
    Parameters:
    
    pCriteriaObject - ProjectTriggerDataObject filled with criteria values.
    
    pLimit - Limit for the number of rows to be returned.
    
    pOffset - offset number from which the limit starts.pass 0 to start at begining of query result.
    
    Returns:
    
    Since:
    
    6.5
  - updateProjectTrigger
```
ProjectTriggerDataObject updateProjectTrigger(ProjectTriggerDataObject pPojo)
```
    Updates Project Trigger based on the project trigger details.
    
    Parameters:
    
    pPojo - Object containing project trigger details to update the project trigger.
    
    Returns:
    
    A simple pojo of project trigger details.
    
    Throws:
    
    FlexDeployRowNotFoundException - If no project trigger is found for the given project trigger details.
    
    Since:
    
    6.5
  - patchProjectTrigger
```
ProjectTriggerDataObject patchProjectTrigger(ProjectTriggerDataObject pPojo)
```
    Updates a project trigger with the provided data. This will only update fields that are passed in the pojo.
    
    Parameters:
    
    pPojo - Object containing Project trigger details to update the project trigger.
    
    Returns:
    
    A simple pojo of project trigger details.
    
    Throws:
    
    FlexDeployRowNotFoundException - If no project trigger is found for the given project trigger details.
    
    Since:
    
    6.5
  - deleteProjectTrigger
```
void deleteProjectTrigger(java.lang.Long pProjectTriggerId)
```
    Deletes the project trigger based on Project Trigger id.
    
    Parameters:
    
    pProjectTriggerId - Project trigger Id to delete the respective project trigger.
    
    Since:
    
    6.5
  - createWorkItem
```
FlxWorkItemDataObject createWorkItem(FlxWorkItemDataObject pPojo)
```
    Creates a work item with the provided data.Returns the work item details after creation.
    
    Parameters:
    
    pPojo - Object containing work item details to create the work item.
    
    Returns:
    
    A simple pojo of work item details.
    
    Since:
    
    7.0
  - updateWorkItem
```
FlxWorkItemDataObject updateWorkItem(FlxWorkItemDataObject pPojo)
```
    Updates work item based on the work item details. This will updates like type, status, title, description, assignee and custom fields.
    
    Parameters:
    
    pPojo - Object containing work item details to update the work item.
    
    Returns:
    
    A simple pojo of work item details.
    
    Since:
    
    7.0
  - patchWorkItem
```
FlxWorkItemDataObject patchWorkItem(FlxWorkItemDataObject pPojo)
```
    Patches a work item with the provided data. This will only update fields that are passed in the pojo. This will patches like type, status, title, description and assignee.
    
    Parameters:
    
    pPojo - Object containing work item details to update the work item.
    
    Returns:
    
    A simple pojo of work item details.
    
    Since:
    
    7.0
  - findWorkItemByNumber
```
FlxWorkItemDataObject findWorkItemByNumber(java.lang.String pWorkItemNumber)
```
    Gets work item based on work item number.
    
    Parameters:
    
    pWorkItemNumber - work item number to get the work item details.
    
    Returns:
    
    A simple pojo of work item details.
    
    Throws:
    
    FlexDeployRowNotFoundException - If no flex work item is found for the given work item number.
    
    Since:
    
    7.0
  - updateWorkItemStatus
```
FlxWorkItemDataObject updateWorkItemStatus(java.lang.String pWorkItemNumber,
                                           java.lang.String pStatusName)
```
    Updates a work item status.
    
    Parameters:
    
    pWorkItemNumber - work item number.
    
    pStatusId - work item status id.
    
    Returns:
    
    A simple pojo of work item details.
    
    Since:
    
    7.0
  - updateWorkItemType
```
FlxWorkItemDataObject updateWorkItemType(java.lang.String pWorkItemNumber,
                                         java.lang.String pTypeCode)
```
    Updates a work item Type.
    
    Parameters:
    
    pWorkItemNumber - work item number.
    
    pTypeCode - work item type code
    
    Returns:
    
    A simple pojo of work item details.
    
    Since:
    
    7.0
  - updateWorkItemAssignee
```
FlxWorkItemDataObject updateWorkItemAssignee(java.lang.String pWorkItemNumber,
                                             java.lang.String pUserName)
```
    Updates a work item Assignee.
    
    Parameters:
    
    pWorkItemNumber - work item number.
    
    pUserName - user name.
    
    Returns:
    
    A simple pojo of work item details.
    
    Since:
    
    7.0
  - getWorkItemTypes
```
java.util.List<FlxWorkItemTypeDataObject> getWorkItemTypes()
```
    Gets the work item types.
    
    Returns:
    
    List of FlxWorkItemTypeDataObject objects
    
    Since:
    
    7.0
  - getWorkItemStatuses
```
java.util.List<FlxWorkItemStatusDataObject> getWorkItemStatuses()
```
    Gets the work item statuses.
    
    Returns:
    
    List of FlxWorkItemStatusDataObject objects
    
    Since:
    
    7.0
  - addWorkItemComment
```
FlxWorkItemCommentDataObject addWorkItemComment(java.lang.String pWorkItemNumber,
                                                java.lang.String pComment)
```
    Adds a work item comment with the provided data.
    
    Parameters:
    
    pWorkItemNumber - work item number.
    
    pComment - comment.
    
    Returns:
    
    A simple pojo of flex work item comment details.
    
    Since:
    
    7.0
  - getWorkItemsForSuccessfulExecutions
```
java.util.List<WorkItemDataObject> getWorkItemsForSuccessfulExecutions(java.lang.Long pSnapshotId,
                                                                       java.lang.Long pEnvironmentId)
```
    Gets Work Item details associated with successful execution for given snapshort and environment.
    
    Parameters:
    
    pSnapshotId - Id of the snapshort.
    
    pEnvironmentId - Id of the enviornment.
    
    Returns:
    
    A simple pojoList of the work item details.
    
    Since:
    
    7.0
  - getWorkItemsForAllExecutions
```
java.util.List<WorkItemDataObject> getWorkItemsForAllExecutions(java.lang.Long pSnapshotId,
                                                                java.lang.Long pEnvironmentId)
```
    Gets Work Item details associated with all execution for given snapshort and environment.
    
    Parameters:
    
    pSnapshotId - Id of the snapshort.
    
    pEnvironmentId - Id of the enviornment.
    
    Returns:
    
    A simple pojoList of the work item details.
    
    Since:
    
    7.0
  - getWorkItemsForFailedExecutions
```
java.util.List<WorkItemDataObject> getWorkItemsForFailedExecutions(java.lang.Long pSnapshotId,
                                                                   java.lang.Long pEnvironmentId)
```
    Gets Work Item details associated with failed execution for given snapshort and environment.
    
    Parameters:
    
    pSnapshotId - Id of the snapshort.
    
    pEnvironmentId - Id of the enviornment.
    
    Returns:
    
    A simple pojoList of the work item details.
    
    Since:
    
    7.0
  - getWorkItemsForSnapshotVersions
```
java.util.List<WorkItemDataObject> getWorkItemsForSnapshotVersions(java.lang.Long pSnapshotId)
```
    Gets Work Item details associated with snapshort versions.
    
    Parameters:
    
    pSnapshotId - Id of the snapshort.
    
    Returns:
    
    A simple pojoList of the work item details.
    
    Since:
    
    7.0
  - saveWorkItemFieldData
```
java.util.List<FlxWorkItemFieldDataDataObject> saveWorkItemFieldData(java.lang.String pWorkItemNumber,
                                                                     java.lang.String pFieldName,
                                                                     java.io.Serializable pValue)
```
    Saves work item field data on given work item number, field name and value.
    
    Parameters:
    
    pWorkItemNumber - work item number.
    
    pFieldName - field name.
    
    pValue - field value.
    
    Returns:
    
    List of work item field details.
    
    Since:
    
    7.0
  - getWorkItemFieldData
```
java.util.List<FlxWorkItemFieldDataDataObject> getWorkItemFieldData(java.lang.String pWorkItemNumber)
```
    Returns List of work item field details for work item number.
    
    Parameters:
    
    pFlxWorkItemId -
    
    Returns:
    
    List of work item field details.
    
    Since:
    
    7.0
  - parseWorkItemRichText
```
java.lang.String parseWorkItemRichText(java.lang.String pWorkItemRichText)
```
    Parse Rich Text to retrieve raw text.
    
    Parameters:
    
    pWorkItemRichText - Rich Text
    
    Returns:
    
    Raw text.
    
    Since:
    
    7.0
  - getUsersFromGroupName
```
java.util.List<FDUser> getUsersFromGroupName(java.lang.String pGroupName)
```
    Gets a list of FDUser objects that are members of the group with the given group name.
    
    Parameters:
    
    pGroupName - FlexDeploy Group name to use.
    
    Returns:
    
    List of FDUser objects.
    
    Since:
    
    7.0
  - getReportsByWorkflowExecutionId
```
java.util.List<WorkflowExecutionReportDataObject> getReportsByWorkflowExecutionId(java.lang.Long pWorkflowExecutionId)
```
    Gets a list of WorkflowExecutionReportDataObject objects that are associated with a workflow execution
    
    Parameters:
    
    pWorkflowExecutionId - Workflow Execution ID
    
    Returns:
    
    List of WorkflowExecutionReportDataObject objects.
    
    Since:
    
    6.5.0.4
  - getReportDataByWorkflowExecutionReportId
```
java.io.InputStream getReportDataByWorkflowExecutionReportId(java.lang.Long pWorkflowExecutionReportId)
```
    Get a report by Workflow Execution Report ID. To find the workflow execution report ID use getReportsByWorkflowExecutionId
    
    Parameters:
    
    pWorkflowExecutionReportId - Workflow Execution Report ID
    
    Returns:
    
    Input stream of the file
    
    Since:
    
    6.5.0.4
  - getProjectBranchById
```
ProjectStreamDataObject getProjectBranchById(java.lang.Long pBranchId,
                                             java.lang.Long pProjectId)
                                      throws FlexDeployRowNotFoundException
```
    Returns the project branch details for given branchId and projectId
    
    Parameters:
    
    pBranchId -
    
    pProjectId -
    
    Returns:
    
    A pojo with Project branch details
    
    Throws:
    
    FlexDeployRowNotFoundException - If no project branch is found for given branchId and projectId
    
    Since:
    
    6.5.0.5
  - getEndpointById
```
EndpointDataObject getEndpointById(java.lang.Long pEndpointId)
```
    Returns Endpoint information for a given endpoint Id.
    
    Parameters:
    
    pEndpointId - - Endpoint id of the Endpoint to retrive.
    
    Returns:
    
    Object containing meta data about the given Endpoint.
    
    Throws:
    
    FlexDeployRowNotFoundException - If Endpoint not found for given pEndpointId.
    
    Since:
    
    6.5.0.5
  - getEndpointByName
```
EndpointDataObject getEndpointByName(java.lang.String pEndpointName)
```
    Returns Endpoint information for a given Endpoint Name.
    
    Parameters:
    
    pEndpointName - - Endpoint name of the Endpoint to retrive.
    
    Returns:
    
    Object containing meta data about the given Endpoint.
    
    Throws:
    
    FlexDeployRowNotFoundException - If Endpoint not found for given pEndpointName.
    
    Since:
    
    6.5.0.5
  - createEndpoint
```
EndpointDataObject createEndpoint(EndpointDataObject pEndpointDataObject)
```
    Create Endpoint with the provided data. Returns the Endpoint details after creation.
    
    Parameters:
    
    pEndpointDataObject - - Object containing the Endpoint details to update the Endpoint.
    
    Returns:
    
    A data object of the Endpoint details.
    
    Since:
    
    6.5.0.5
  - updateEndpoint
```
EndpointDataObject updateEndpoint(EndpointDataObject pEndpointDataObject)
```
    Update Endpoint based on the Endpoint details.
    
    Parameters:
    
    pEndpointDataObject - - Object containing the Endpoint details to update the Endpoint.
    
    Returns:
    
    A data object of Endpoint details.
    
    Throws:
    
    FlexDeployRowNotFoundException - If no Endpoint is found for the given Endpoint details.
    
    Since:
    
    6.5.0.5
  - patchEndpoint
```
EndpointDataObject patchEndpoint(EndpointDataObject pEndpointDataObject)
```
    Update Endpoint with the provided data. This will only update fields that are passed in the dataObject.
    
    Parameters:
    
    pEndpointDataObject - - Object containing the Endpoint details to update the Endpoint.
    
    Returns:
    
    A data object of Endpoint details.
    
    Throws:
    
    FlexDeployRowNotFoundException - If no Endpoint is found for the given Endpoint details.
    
    Since:
    
    6.5.0.5
  - searchEndpoints
```
PaginatedResponse<EndpointDataObject> searchEndpoints(EndpointDataObject pCriteriaObject,
                                                      java.lang.Integer pLimit,
                                                      java.lang.Integer pOffset)
```
    Find Endpoints using criteria values provided. Results are limited by pLimit and pOffset.
    
    Parameters:
    
    pCriteriaObject - - EndpointDataObject filled with criteria values.
    
    pLimit - - Limit for the number of rows to be returned.
    
    pOffset - - offset number from which the limit starts. Pass 0 to start at begining of query result.
    
    Returns:
    
    Since:
    
    6.5.0.5
  - getGroupById
```
FdGroupDataObject getGroupById(java.lang.Long pGroupId)
```
    Returns Group information for a given group Id.
    
    Parameters:
    
    pGroupId - - Group id of the Group to retrive.
    
    Returns:
    
    Object containing meta data about the given Group.
    
    Throws:
    
    FlexDeployRowNotFoundException - If Group not found for given pGroupId.
    
    Since:
    
    6.5.0.5
  - getGroupByName
```
FdGroupDataObject getGroupByName(java.lang.String pGroupName)
```
    Returns Group information for a given group name.
    
    Parameters:
    
    pGroupName - - Group name of the Group to retrive.
    
    Returns:
    
    Object containing meta data about the given Group.
    
    Throws:
    
    FlexDeployRowNotFoundException - If Group not found for given pGroupName.
    
    Since:
    
    6.5.0.5
  - createGroup
```
FdGroupDataObject createGroup(FdGroupDataObject pGroupDataObject)
```
    Create Group with the provided data. Returns the Group details after creation.
    
    Parameters:
    
    pGroupDataObject - - Object containing the Group details to create the Group.
    
    Returns:
    
    A data object of the Group details.
    
    Since:
    
    6.5.0.5
  - patchGroup
```
FdGroupDataObject patchGroup(FdGroupDataObject pGroupDataObject)
```
    Update Group with the provided data. This will only update fields that are passed in the dataObject.
    
    Parameters:
    
    pGroupDataObject - - Object containing the Group details to update the Group.
    
    Returns:
    
    A data object of the Group details.
    
    Throws:
    
    FlexDeployRowNotFoundException - If no Group is found for the given Group details.
    
    Since:
    
    6.5.0.5
  - updateGroup
```
FdGroupDataObject updateGroup(FdGroupDataObject pGroupDataObject)
```
    Update Group based on the Group details.
    
    Parameters:
    
    pGroupDataObject - - Object containing the Group details to update the Group.
    
    Returns:
    
    A data object of the Group details.
    
    Throws:
    
    FlexDeployRowNotFoundException - If no Group is found for the given Group details.
    
    Since:
    
    6.5.0.5
  - getSnapshotDetails
```
RelSnapshotDataObject getSnapshotDetails(java.lang.Long pSnapshotId)
```
    Return a release snapshot data object by id.
    
    Parameters:
    
    pSnapshotId - Id of the snapshot.
    
    Returns:
    
    A pojo contain the release snapshot data object and child data.
    
    Since:
    
    6.5.0.5
  - isBotUsername
```
boolean isBotUsername(java.lang.String pUsername)
```
    Return whether an username (case-insensitive) is a FlexDeploy bot username and not a FlexDeploy user.
    
    Parameters:
    
    pUsername -
    
    Returns:
    
    true if a FlexDeploy bot username
    
    Since:
    
    6.5.0.5
  - searchGroups
```
PaginatedResponse<FdGroupDataObject> searchGroups(FdGroupDataObject pGroupObject,
                                                  java.lang.Integer pLimit,
                                                  java.lang.Integer pOffset)
```
    Find Groups using criteria values provided. Results are limited by FlexPageInput.
    
    Parameters:
    
    pGroupObject - - FdGroupDataObject filled with criteria values.
    
    pLimit - - Limit for the number of rows to be returned.
    
    pOffset - - Offset number from which the limit starts. Pass 0 to start at begining of query result.
    
    Returns:
    
    Since:
    
    6.5.0.5
  - getUserById
```
FdUserDataObject getUserById(java.lang.Long pUserId)
```
    Returns User information along with the user attributes and group detail for a given user Id.
    
    Parameters:
    
    pUserId - - User id of the User to retrive.
    
    Returns:
    
    Object containing meta data about the given User.
    
    Throws:
    
    FlexDeployRowNotFoundException - If User not found for given pUserId.
    
    Since:
    
    6.5.0.5
  - createUser
```
FdUserDataObject createUser(FdUserDataObject pUserDataObj)
```
    Create User with the provided data. Returns the User details along with the user attributes and group detail after creation.
    
    Parameters:
    
    pUserDataObj - - Object containing the User details to create the User.
    
    Returns:
    
    A data object of the User details.
    
    Since:
    
    6.5.0.5
  - patchUser
```
FdUserDataObject patchUser(FdUserDataObject pUserDataObject)
```
    Update User with the provided data. This will only update fields that are passed in the dataObject. Along with user detail user attributes and group can be updated.
    
    Parameters:
    
    pUserDataObject - - Object containing the User details to update the User.
    
    Returns:
    
    A data object of the Group details.
    
    Throws:
    
    FlexDeployRowNotFoundException - If no User is found for the given User details.
    
    Since:
    
    6.5.0.5
  - updateUser
```
FdUserDataObject updateUser(FdUserDataObject pUserDataObject)
```
    Update User based on the User details. Along with user detail user attributes and group can be updated.
    
    Parameters:
    
    pUserDataObject - - Object containing the User details to update the User.
    
    Returns:
    
    A data object of the User details.
    
    Throws:
    
    FlexDeployRowNotFoundException - If no User is found for the given User details.
    
    Since:
    
    6.5.0.5
  - searchUsers
```
PaginatedResponse<FdUserDataObject> searchUsers(FdUserDataObject pUserObject,
                                                java.lang.Integer pLimit,
                                                java.lang.Integer pOffset)
```
    Find Users using criteria values provided. Results are limited by FlexPageInput.
    
    Parameters:
    
    pUserObject - - FdUserDataObject filled with criteria values.
    
    pLimit - - Limit for the number of rows to be returned.
    
    pOffset - - Offset number from which the limit starts. Pass 0 to start at begining of query result.
    
    Returns:
    
    Since:
    
    6.5.0.5
  - deleteFlxWorkItem
```
void deleteFlxWorkItem(java.lang.Long pFlexWorkItemId)
```
    Deletes a Flex Work Item
    
    Parameters:
    
    pFlexWorkItemId - - the id of the Flex Work Item
    
    Since:
    
    6.5.0.5
  - searchFlxWorkItems
```
PaginatedResponse<FlxWorkItemDataObject> searchFlxWorkItems(FlxWorkItemDataObject pCriteriaObject,
                                                            java.lang.Integer pLimit,
                                                            java.lang.Integer pOffset)
```
    Returns a list of Flex Work Items based on criteria values provided. Results are limited by pLimit and pOffset.
    
    Parameters:
    
    pCriteriaObject - - The FlxWorkItemDataObject filled with criteria values
    
    pLimit - - number of rows to return
    
    pOffset - - pass 0 to start at beginning of query result
    
    Returns:
    
    The results of the search
    
    Since:
    
    6.5.0.5
  - getFlxWorkItemStatusWithId
```
FlxWorkItemStatusDataObject getFlxWorkItemStatusWithId(java.lang.Long pFlexWorkItemStatusId)
```
    Finds Flex Work Item Status using Id.
    
    Parameters:
    
    pFlexWorkItemStatusId - - Id of Flex Work Item Status to find.
    
    Returns:
    
    The FlexWorkItemStatus that was found
    
    Throws:
    
    FlexDeployRowNotFoundException - if no row found for pFlexWorkItemStatusId.
  - searchFlxWorkItemStatuses
```
PaginatedResponse<FlxWorkItemStatusDataObject> searchFlxWorkItemStatuses(FlxWorkItemStatusDataObject pCriteriaObject,
                                                                         java.lang.Integer pLimit,
                                                                         java.lang.Integer pOffset)
```
    Returns a list of Flex Work Item Statuses based on criteria values provided. Results are limited by pLimit and pOffset.
    
    Parameters:
    
    pCriteriaObject - - FlxWorkItemStatusDataObject filled with criteria values
    
    pLimit - - number of rows to return
    
    pOffset - - pass 0 to start at beginning of query result
    
    Returns:
    
    the results of the search
    
    Since:
    
    6.5.0.5
  - getFlxWorkItemTypeWithCode
```
FlxWorkItemTypeDataObject getFlxWorkItemTypeWithCode(java.lang.String pFlexWorkItemTypeCode)
```
    Finds Flex Work Item Type using Code.
    
    Parameters:
    
    pFlexWorkItemTypeCode - - Code of Flex Work Item Type to find.
    
    Returns:
    
    the Flex Work Item Type that was found
    
    Throws:
    
    FlexDeployRowNotFoundException - if no row found for pFlexWorkItemTypeCode.
  - searchFlxWorkItemTypes
```
PaginatedResponse<FlxWorkItemTypeDataObject> searchFlxWorkItemTypes(FlxWorkItemTypeDataObject pCriteriaObject,
                                                                    java.lang.Integer pLimit,
                                                                    java.lang.Integer pOffset)
```
    Returns a list of Flex Work Item Types based on criteria values provided. Results are limited by pLimit and pOffset.
    
    Parameters:
    
    pCriteriaObject - - FlexWorkItemTypeDataObject filled with criteria values
    
    pLimit - - number of rows to return
    
    pOffset - - pass 0 to start at the beginning of query result
    
    Returns:
    
    the results of the search
    
    Since:
    
    6.5.0.5
  - getFlxWorkItemFieldWithId
```
FlxWorkItemFieldDataObject getFlxWorkItemFieldWithId(java.lang.Long pFlexWorkItemFieldId)
```
    Finds Flex Work Item Field using Id.
    
    Parameters:
    
    pFlexWorkItemfieldId - - Id of Flex Work Item Field to find.
    
    Returns:
    
    the Flex Work Item Field that was found
    
    Throws:
    
    FlexDeployRowNotFoundException - if no row found for pFlexWorkItemFieldId.
  - searchFlxWorkItemFields
```
PaginatedResponse<FlxWorkItemFieldDataObject> searchFlxWorkItemFields(FlxWorkItemFieldDataObject pCriteriaObject,
                                                                      java.lang.Integer pLimit,
                                                                      java.lang.Integer pOffset)
```
    Returns a list of Flex Work Item Fields based on criteria values provided. Results are limited by pLimit and pOffset.
    
    Parameters:
    
    pCriteriaObject - - FlexWorkItemFieldDataObject filled with criteria values
    
    pLimit - - number of rows to return
    
    pOffset - - pass 0 to start at the beginning of query result
    
    Returns:
    
    the results of the search
    
    Since:
    
    6.5.0.5
  - saveFlxWorkItemFields
```
java.util.List<FlxWorkItemFieldDataObject> saveFlxWorkItemFields(java.util.List<FlxWorkItemFieldDataObject> pPojos,
                                                                 java.lang.String pGroupCode)
```
    Updates all Flex Work Item Fields within a group. Anything in the passed list will be added/updated, and anything not in this list that is in the group will be removed.
    
    Parameters:
    
    pPojos - - The Flex Work Item Fields to be saved
    
    pGroupCode - - The code of the group that is being saved to
    
    Returns:
    
    the saved fields
    
    Since:
    
    6.5.0.5
  - patchFlxWorkItemField
```
FlxWorkItemFieldDataObject patchFlxWorkItemField(FlxWorkItemFieldDataObject pPojo)
```
    Patches a Flex Work Item Field with the provided data. This will only update fields that are passed in the pojo. This will patches like type, status, title, description and assignee.
    
    Parameters:
    
    pPojo - Object containing Flex Work Item Field details to update the Flex Work Item Field.
    
    Returns:
    
    A simple pojo of Flex Work Item Field details.
    
    Since:
    
    6.5.0.5
  - getFlxWorkItemFieldGroupWithCode
```
PropertyKeyGroupDataObject getFlxWorkItemFieldGroupWithCode(java.lang.String pFlexWorkItemFieldGroupCode)
```
    Finds a Flex Work Item Field Group using Code.
    
    Parameters:
    
    pFlexWorkItemFieldCode - - Code of Flex Work Item Field Group to find.
    
    Returns:
    
    The Flex Work Item Field Group that was found
    
    Throws:
    
    FlexDeployRowNotFoundException - if no row found for pFlexWorkItemFieldGroupCode.
  - searchFlxWorkItemFieldGroups
```
PaginatedResponse<PropertyKeyGroupDataObject> searchFlxWorkItemFieldGroups(PropertyKeyGroupDataObject pCriteriaObject,
                                                                           java.lang.Integer pLimit,
                                                                           java.lang.Integer pOffset)
```
    Returns a list of Flex Work Item Field Groups based on criteria values provided. Results are limited by pLimit and pOffset.
    
    Parameters:
    
    pCriteriaObject - - PropertyKeyGroupDataObject that is filled with criteria values
    
    pLimit - - number of rows to return
    
    pOffset - - pass 0 to start at the beginning of query result
    
    Returns:
    
    the results of the search
    
    Since:
    
    6.5.0.5
  - createFlxWorkItemFieldGroup
```
PropertyKeyGroupDataObject createFlxWorkItemFieldGroup(PropertyKeyGroupDataObject pDobj)
```
    Creates a Flex Work Item Field Group with the provided data. Returns the Flex Work Item Field Group after creation.
    
    Parameters:
    
    pDobj - - the PropertyKeyDefinitionDataObject with the data to be added to the field group
    
    Returns:
    
    the field group that was added
    
    Since:
    
    6.5.0.5
  - updateFlxWorkItemFieldGroup
```
PropertyKeyGroupDataObject updateFlxWorkItemFieldGroup(PropertyKeyGroupDataObject pDobj)
```
    Updates Flex work item field group based on the Flex work item field group details.
    
    Parameters:
    
    pDobj - Object containing Flex Work Item Field Group details to update the Flex Work Item Field Group.
    
    Returns:
    
    the state of the Flex Work Item Field Group after being updated
    
    Since:
    
    6.5.0.5
  - patchFlxWorkItemFieldGroup
```
PropertyKeyGroupDataObject patchFlxWorkItemFieldGroup(PropertyKeyGroupDataObject pDobj)
```
    Patches a Flex Work Item Field Group with the provided data. Only modifies fields that are not null. Returns the Flex Work Item Field Group after the patch.
    
    Parameters:
    
    pDobj - - the data to use to patch the Flex Work Item Field Group with
    
    Returns:
    
    The patched Flex Work Item Field Group
    
    Since:
    
    6.5.0.5
  - deleteFlxWorkItemFieldGroup
```
void deleteFlxWorkItemFieldGroup(java.lang.String pFlexWorkItemFieldGroupCode)
```
    Deletes a Flex Work Item Field Group
    
    Parameters:
    
    pFlexWorkItemFieldGroupCode - - the code of the Flex Work Item Field Group
    
    Since:
    
    6.5.0.5
  - createFlxWorkItemField
```
FlxWorkItemFieldDataObject createFlxWorkItemField(FlxWorkItemFieldDataObject pDobj)
```
    Creates a Flex Work Item Field with the provided data. Returns the created Flex Work Item Field.
    
    Parameters:
    
    pDobj - - an object containing the Flex Work Item Field information
    
    Returns:
    
    the created Flex Work Item Field
    
    Since:
    
    6.5.0.5
  - updateFlxWorkItemField
```
FlxWorkItemFieldDataObject updateFlxWorkItemField(FlxWorkItemFieldDataObject pDobj)
```
    Updates Flex work item field based on the Flex work item field details.
    
    Parameters:
    
    pDobj - Object containing Flex Work Item Field details to update the Flex Work Item Field.
    
    Returns:
    
    the state of the Flex Work Item Field after being updated
    
    Since:
    
    6.5.0.5
  - deleteFlxWorkItemField
```
void deleteFlxWorkItemField(java.lang.Long pFlexWorkItemFieldId)
```
    Deletes a Flex Work Item Field
    
    Parameters:
    
    pFlexWorkItemFieldId - - The id of the Flex Work Item Field to delete
    
    Since:
    
    6.5.0.5
  - createPropertyKeyDefinition
```
PropertyKeyDefinitionDataObject createPropertyKeyDefinition(PropertyKeyDefinitionDataObject pPojo)
```
    Creates a property key definition with the provided data.
    
    Parameters:
    
    pPojo - - Object containing property key definition information.
    
    Returns:
    
    PropertyKeyDefinitionDataObject representing the created property key definition.
    
    Since:
    
    5.4.0.1
  - updatePropertyKeyDefinition
```
PropertyKeyDefinitionDataObject updatePropertyKeyDefinition(PropertyKeyDefinitionDataObject pPojo)
```
    Updates a property key definition with the provided data.
    
    Parameters:
    
    pPojo - Object containing property key definition information.
    
    Returns:
    
    PropertyKeyDefinitionDataObject representing the updated property key definition.
    
    Throws:
    
    FlexDeployRowNotFoundException - If no property key is found for the given details.
    
    Since:
    
    6.5.0.5
  - patchPropertyKeyDefinition
```
PropertyKeyDefinitionDataObject patchPropertyKeyDefinition(PropertyKeyDefinitionDataObject pPojo)
```
    Updates a property key definition with the provided data. This will only update fields that are passed in the pojo.
    
    Parameters:
    
    pPojo - Object containing property key definition information.
    
    Returns:
    
    PropertyKeyDefinitionDataObject representing the patched property key definition.
    
    Throws:
    
    FlexDeployRowNotFoundException - If no property key is found for the given details.
    
    Since:
    
    6.5.0.5
  - getPropertyKeyDefinition
```
PropertyKeyDefinitionDataObject getPropertyKeyDefinition(java.lang.Long pPropertyKeyDefinitionId)
```
    Retrieves a property key definition by its ID.
    
    Parameters:
    
    pPropertyKeyDefinitionId - ID of the property key definition to retrieve.
    
    Returns:
    
    PropertyKeyDefinitionDataObject representing the retrieved property key definition.
    
    Throws:
    
    FlexDeployRowNotFoundException - If propkey not found for given pPropertyKeyDefinitionId.
  - searchPropertyKeyDefinitions
```
PaginatedResponse<PropertyKeyDefinitionDataObject> searchPropertyKeyDefinitions(PropertyKeyDefinitionDataObject pSearchParams,
                                                                                java.lang.Integer pLimit,
                                                                                java.lang.Integer pOffset)
```
    Searches for property key definitions based on the provided search parameters and pagination input.
    
    Parameters:
    
    pSearchParams - Object containing the search parameters for property key definitions.
    
    pLimit - Limit for the number of rows to be returned.
    
    pOffset - offset number from which the limit starts.pass 0 to start at begining of query result.
    
    Returns:
    
    PaginatedResponse containing the list of property key definitions matching the search criteria.
    
    Since:
    
    6.5.0.5
  - getPropertyKeyDefinition
```
PropertyKeyDefinitionDataObject getPropertyKeyDefinition(java.lang.String pKeyName)
```
    Retrieves a property key definition by its key name.
    
    Parameters:
    
    pKeyName - Name of the property key definition to retrieve.
    
    Returns:
    
    PropertyKeyDefinitionDataObject representing the retrieved property key definition.
    
    Throws:
    
    FlexDeployRowNotFoundException - If propkey not found for the given pKeyName.
  - updateWorkflowPropertySet
```
PropertySetDataObject updateWorkflowPropertySet(PropertySetDataObject pPropertySet)
```
    Updates a property set with the provided data.
    
    Parameters:
    
    pPropertySet - - Object containing property set information.
    
    Returns:
    
    PropertySetDataObject representing the updated property set.
    
    Throws:
    
    FlexDeployRowNotFoundException - if no property set is found for the given details.
    
    Since:
    
    6.5.0.5
  - searchPropertySets
```
PaginatedResponse<PropertySetDataObject> searchPropertySets(PropertySetDataObject pSearchParams,
                                                            java.lang.Integer pLimit,
                                                            java.lang.Integer pOffset)
```
    Searches for property sets based on the provided search parameters and pagination input.
    
    Parameters:
    
    pSearchParams - - Object containing the search parameters for property sets.
    
    pLimit - - Limit for the number of rows to be returned.
    
    pOffset - - Offset number from which the limit starts. Pass 0 to start at the beginning of the query result.
    
    Returns:
    
    PaginatedResponse containing the list of property sets matching the search criteria.
    
    Since:
    
    6.5.0.5
  - getPropertySet
```
PropertySetDataObject getPropertySet(java.lang.Long pPropertySetId)
```
    Retrieves a property set by its ID.
    
    Parameters:
    
    pPropertySetId - - ID of the property set to retrieve.
    
    Returns:
    
    PropertySetDataObject representing the retrieved property set.
    
    Throws:
    
    FlexDeployRowNotFoundException - if the property setis not found for the given pPropertySetId.
  - getCredentialById
```
CredentialDataObject getCredentialById(java.lang.Long pCredentialId)
```
    Returns Credential information for a given Credential Id.
    
    Parameters:
    
    pCredentialId - - Credential id of the Credential to retrive.
    
    Returns:
    
    Object containing meta data about the given Credential.
    
    Throws:
    
    FlexDeployRowNotFoundException - If Credential not found for given pCredentialId.
    
    Since:
    
    6.5.0.5
  - createCredential
```
CredentialDataObject createCredential(CredentialDataObject pCredentialDataObject)
```
    Create Credential with the provided data. Returns the Credential details after creation.
    
    Parameters:
    
    pCredentialDataObject - - Object containing the Credential details to create the Credential.
    
    Returns:
    
    A data object of the Credential details.
    
    Since:
    
    6.5.0.5
  - patchCredential
```
CredentialDataObject patchCredential(CredentialDataObject pCredentialDataObject)
```
    Update Credential with the provided data. This will only update fields that are passed in the dataObject.
    
    Parameters:
    
    pCredentialDataObject - - Object containing the Credential details to update the Credential.
    
    Returns:
    
    A data object of Credential details.
    
    Throws:
    
    FlexDeployRowNotFoundException - If no Credential is found for the given Credential details.
    
    Since:
    
    6.5.0.5
  - updateCredential
```
CredentialDataObject updateCredential(CredentialDataObject pCredentialDataObject)
```
    Update Credential with the provided data.
    
    Parameters:
    
    pCredentialDataObject - - Object containing the Credential details to update the Credential.
    
    Returns:
    
    A data object of Credential details.
    
    Throws:
    
    FlexDeployRowNotFoundException - If no Credential is found for the given Credential details.
    
    Since:
    
    6.5.0.5
  - searchCredentials
```
PaginatedResponse<CredentialDataObject> searchCredentials(CredentialDataObject pCriteriaObject,
                                                          java.lang.Integer pLimit,
                                                          java.lang.Integer pOffset)
```
    Find Credentials using criteria values provided. Results are limited by pLimit and pOffset.
    
    Parameters:
    
    pCriteriaObject - - CredentialDataObject filled with criteria values.
    
    pLimit - - Limit for the number of rows to be returned.
    
    pOffset - - offset number from which the limit starts. Pass 0 to start at begining of query result.
    
    Returns:
    
    Since:
    
    6.5.0.5
  - getCredentialByName
```
CredentialDataObject getCredentialByName(java.lang.String pCredentialName)
```
    Returns Credential information for a given Credential name.
    
    Parameters:
    
    pCredentialName - - Credential id of the Credential to retrive.
    
    Returns:
    
    Object containing meta data about the given Credential.
    
    Throws:
    
    FlexDeployRowNotFoundException - If Credential not found for given pCredentialName.
    
    Since:
    
    6.5.0.5
  - createEnvironment
```
EnvironmentDataObject createEnvironment(EnvironmentDataObject pEnvDataObject)
```
    Create Environment with the provided data. Returns the Environment details after creation.
    
    Parameters:
    
    pEnvDataObject - - Object containing the Environment details to create the Environment.
    
    Returns:
    
    A data object of the Environment details.
    
    Since:
    
    6.5.0.5
  - patchEnvironment
```
EnvironmentDataObject patchEnvironment(EnvironmentDataObject pEnvDataObject)
```
    Update Environment with the provided data. This will only update fields that are passed in the dataObject.
    
    Parameters:
    
    pEnvDataObject - - Object containing the Environment details to update the Environment.
    
    Returns:
    
    A data object of Environment details.
    
    Throws:
    
    FlexDeployRowNotFoundException - If no Environment is found for the given Environment details.
    
    Since:
    
    6.5.0.5
  - updateEnvironment
```
EnvironmentDataObject updateEnvironment(EnvironmentDataObject pEnvDataObject)
```
    Update Environment based on the Environment details.
    
    Parameters:
    
    pEnvDataObject - - Object containing the Environment details to update the Environment.
    
    Returns:
    
    A data object of Environment details.
    
    Throws:
    
    FlexDeployRowNotFoundException - If no Environment is found for the given Environment details.
    
    Since:
    
    6.5.0.5
  - deleteEnvironment
```
void deleteEnvironment(java.lang.Long pEnvironmentId)
```
    Deletes an Environment.
    
    Parameters:
    
    pEnvironmentId - - the id of the Environment.
    
    Since:
    
    6.5.0.5
  - deleteEndpoint
```
void deleteEndpoint(java.lang.Long pEndpointId)
```
    Deletes an Endpoint.
    
    Parameters:
    
    pEndpointId - - the id of the Endpoint.
    
    Since:
    
    6.5.0.5
  - deleteCredential
```
void deleteCredential(java.lang.Long pCredentialId)
```
    Deletes a Credential.
    
    Parameters:
    
    pCredentialId - - the id of the Credential.
    
    Since:
    
    6.5.0.5
  - createTargetGroup
```
TargetGroupDataObject createTargetGroup(TargetGroupDataObject pTargetGroupDataObj)
```
    Create TargetGroup with the provided data. Returns the TargetGroup details after creation.
    
    Parameters:
    
    pTargetGroupDataObj - - Object containing the TargetGroup details to create the TargetGroup.
    
    Returns:
    
    A data object of the TargetGroup details.
    
    Since:
    
    6.5.0.5
  - patchTargetGroup
```
TargetGroupDataObject patchTargetGroup(TargetGroupDataObject pTargetGroupDataObj)
```
    Update TargetGroup with the provided data. This will only update fields that are passed in the dataObject.
    
    Parameters:
    
    pTargetGroupDataObj - - Object containing the TargetGroup details to update the TargetGroup.
    
    Returns:
    
    A data object of the TargetGroup details.
    
    Throws:
    
    FlexDeployRowNotFoundException - If no TargetGroup is found for the given TargetGroup details.
    
    Since:
    
    6.5.0.5
  - updateTargetGroup
```
TargetGroupDataObject updateTargetGroup(TargetGroupDataObject pTargetGroupDataObj)
```
    Update TargetGroup based on the TargetGroup details.
    
    Parameters:
    
    pTargetGroupDataObj - - Object containing the TargetGroup details to update the TargetGroup.
    
    Returns:
    
    A data object of the TargetGroup details.
    
    Throws:
    
    FlexDeployRowNotFoundException - If no TargetGroup is found for the given TargetGroup details.
    
    Since:
    
    6.5.0.5
  - deleteTargetGroup
```
void deleteTargetGroup(java.lang.Long pTargetGroupId)
```
    Deletes a TargetGroup.
    
    Parameters:
    
    pTargetGroupId - - the id of the TargetGroup.
    
    Since:
    
    6.5.0.5
  - assignGroupToUser
```
void assignGroupToUser(java.lang.Long pGroupId,
                       java.lang.Long pUserId)
                throws FlexDeployRowNotFoundException
```
    Assigns Group to User with the provided data.
    
    Parameters:
    
    pGroupId - - Id of the Group that has to be assigned to the user.
    
    pUserId - - Id of the User to which Group has be assigned.
    
    Throws:
    
    FlexDeployRowNotFoundException - If no Group or User is found for the given details.
    
    Since:
    
    6.5.0.6
  - unassignGroupFromUser
```
void unassignGroupFromUser(java.lang.Long pGroupId,
                           java.lang.Long pUserId)
                    throws FlexDeployRowNotFoundException
```
    Unassigns Group from User with the provided data.
    
    Parameters:
    
    pGroupId - - Id of the Group that has to be unassigned from the user.
    
    pUserId - - Id of the User from which Group has be unassigned.
    
    Throws:
    
    FlexDeployRowNotFoundException - If no Group or User is found for the given details.
    
    Since:
    
    6.5.0.6
  - assignGroupToUser
```
void assignGroupToUser(java.lang.String pGroupName,
                       java.lang.String pUserName)
                throws FlexDeployValidationException
```
    Assigns Group to User with the provided data.
    
    Parameters:
    
    pGroupName - - Name of the Group that has to be assigned to the user.
    
    pUserName - - Name of the User to which Group has be assigned.
    
    Throws:
    
    FlexDeployValidationException - If no Group or User is found for the given details.
    
    Since:
    
    6.5.0.6
  - unassignGroupFromUser
```
void unassignGroupFromUser(java.lang.String pGroupName,
                           java.lang.String pUserName)
                    throws FlexDeployValidationException
```
    Unassigns Group from User with the provided data.
    
    Parameters:
    
    pGroupName - - Name of the Group that has to be unassigned from the user.
    
    pUserName - - Name of the User from which Group has be unassigned.
    
    Throws:
    
    FlexDeployValidationException - If no Group or User is found for the given details.
    
    Since:
    
    6.5.0.6
  - createFolder
```
FolderDataObject createFolder(FolderDataObject pFolderDataObject)
```
    Create Folder with the provided data. Returns the Folder details after creation.
    
    Parameters:
    
    pFolderDataObject - - Object containing the Folder details to create the Folder.
    
    Returns:
    
    A data object of the Folder details.
    
    Since:
    
    6.5.0.6
  - patchFolder
```
FolderDataObject patchFolder(FolderDataObject pFolderDataObject)
```
    Update Folder with the provided data. This will only update fields that are passed in the dataObject.
    
    Parameters:
    
    pFolderDataObject - - Object containing the Folder details to update the Folder.
    
    Returns:
    
    A data object of Folder details.
    
    Throws:
    
    FlexDeployRowNotFoundException - If no Folder is found for the given Folder details.
    
    Since:
    
    6.5.0.6
  - updateFolder
```
FolderDataObject updateFolder(FolderDataObject pFolderDataObject)
```
    Update Folder based on the Folder details.
    
    Parameters:
    
    pFolderDataObject - - Object containing the Folder details to update the Folder.
    
    Returns:
    
    A data object of Folder details.
    
    Throws:
    
    FlexDeployRowNotFoundException - If no Folder is found for the given Folder details.
    
    Since:
    
    6.5.0.6
  - deleteFolder
```
void deleteFolder(java.lang.Long pFolderId)
```
    Deletes a Folder.
    
    Parameters:
    
    pFolderId - - the id of the Folder.
    
    Since:
    
    6.5.0.6
  - patchWorkItemComment
```
FlxWorkItemCommentDataObject patchWorkItemComment(java.lang.String pWorkItemCommentId,
                                                  java.lang.String pComment)
```
    Update a work item comment with the provided data.
    
    Parameters:
    
    pWorkItemCommentId- - work item comment id.
    
    pComment- - work item comment.
    
    Returns:
    
    A simple pojo of flex work item comment details.
    
    Since:
    
    6.5.0.6
  - getWorkItemStatus
```
java.lang.String getWorkItemStatus(WorkItemDataObject pWorkItem)
```
    Gets Work Item Status.
    
    Parameters:
    
    Work - Item Object.
    
    Returns:
    
    Work Item Status.
    
    Since:
    
    6.5.0.8

Interface IFlexDeployFunctions

Method Summary

Method Detail

findLocalChangeLogs

findLocalChangeLogs

findLocalChangeLogs

findLocalChangeLogs

getProject

createProject

updateProject

patchProject

updateProjectProperties

patchProjectProperties

addFilesToPackage

populateFiles

discoverFiles

updatePackageStatus

updatePackage

updatePackage

createPackage

createDynamicPackage

createPackage

deletePackage

buildPackage

buildPackage

buildPackage

buildPackage

buildProject

buildProject

buildProject

buildProject

deployPackage

deployProject

findProjectsForNewBranch

findProjectsForNewBranch

findProjectsForChange

findProjectsForChange

findPackagesForChange

findPackagesForChange

findProjectId

findProjectWithId

findProjectsWithName

searchProjects

findBranchId

createBranch

createBranch

createBranch

updateBranch

patchBranch

inactivateBranch

activateBranch

findIntegrationInstance

createSCMInstance

createSCMInstance

updateSCMInstance

updateSCMInstance

getIntegrationInstance

findCMSInstance

getCMSInstance

getChangeManagementSystemByInstanceCode

getChangeManagementSystemByInstanceName

createIncidentForWorklowRequest

createIncidentByWorkflowType

getChangeManagementSystemByInstanceId

getUsersFromGroupId

downloadLogs

getPluginLogInputStreams

getPluginLogInputStreams

getPackage

getPluginLogs

getFlexDeployBaseUrl

executeUtility

executeUtility

findFolderId

findFolderWithId

findFoldersWithName

searchFolders

searchBranches

getUser

getCurrentlyDeployedVersionId