Publication date: July 2012
Copyright © 2011-2012 Serena Software, Inc. All rights reserved.
This document contains Web Service descriptions for the following services.
Name | Description |
---|---|
RLMUtilService | Serena Release Manager Utility Service |
ReleaseRequestService | Serena Release Manager Release Request Service |
VaultService | Serena Release Manager Vault Service |
DeploymentAutomationService | Serena Release Manager Deployment Automation Service |
Serena Release Manager Utility Service
SOAP
Document
Name | Description |
---|---|
changeDeploymentTasksOrder | Change the order of provided deployment tasks |
checkRelatedItemMaxLimits | This operation will check if a related field in a table is still available for new related items to be related. |
copyAppReleases2ReleaseTrain | Copy related application releases from input release train into target release train with or without release packages info |
copyDeploymentTasks2ReleasePackage | Copy deployment tasks from specified template into specified release package |
copyDeploymentTasks2Template | Copy deployment tasks for specified release package in specified state to specified template |
deleteDeploymentTasks | Delete deployment tasks either for deployment process template or for release package and optional stage. |
deployReleasePackage | This operation manages the release package deployment process. |
deployTask | This operation initiates the deployment of Dimensions CM Vault Task and Nolio Automation Task. This could also drive the deployment of the ZMF Vault task or any supported 3rd Party vault system. |
failReleasePackage | Move the release package into the failed state by using transition that is assigned in FailedDeployTransition. |
getBuildVersion | Returns build version for RLM Utility web service |
getInterfaceVersion | Returns interface version number. |
promoteVaultTask | This operation initiates the promotion of Dimensions CM Vault Task to a specified target stage area. In the future, this should also be able to drive the promotion of the ZMF Vault task or any supported 3rd Party vault system. |
relateChildrenRecords | This operation relates children records by setting their parent field to specified parent ID value. |
relateChildrenRecordsToParent | This operation relates children records to the parent table by setting the children field values specified in the child IDs value. |
relateRecordsInBothDirections | Relates specified records for 2 tables in both directions. Usually there is a multi-relational field in a parent record and a single-relational field in a child record. |
unrelateChildrenRecords | This operation un-relates children records by setting empty values in their parent field. |
unrelateChildrenRecordsFromParent | This operation un-relates children records by setting empty values in their parent field. |
unrelateRecordsInBothDirections | Un-relates specified records for 2 tables in both directions. Usually, we have a multi-relational field in parent record and a single-relational field in child record. This method sets empty values for all children records and removes those children from the multi-relational field in the parent record. |
updateDeploymentTaskStatus | This operation updates the related Deploy Task item status based on the result of the Dimensions CM submitPromoteBaselines or Nolio execution job. |
updateReleasePackageDeployStatus | This method checks the deployment status of all the tasks related to the release package that is currently being deployed. If all the related tasks are in “Completed” state, it will move the release package into the state that is assigned in the NextDeployTransition field. It there is a failure in the deployment process, it will move the release package into the state that is assigned in FailedDeployTransition. |
validateApplicationRelease | Validate Application release record before creation. For now it only checks if name and version are unique. |
validateReleasePackageDeploymentTasks | This operation validates that there are no tasks in the release package that are in “Incomplete” or “Failed” task status. |
validateReleaseTrain | Validate release train record before creation. For now it only checks if name is unique. |
Change the order of provided deployment tasks
urn:changeDeploymentTasksOrder
Document
The input of this method is the document element ns:changeDeploymentTasksOrder having the structure defined by the following table.
Element | Type | Occurs | Description |
---|---|---|---|
![]() |
1..1 | ||
ns:auth | ns:AuthInfo | 0..1 | Authentication information |
ns:tasksOrderInfo | xs:string | 0..1 | Tasks ids and order pairs separated by commas. In form of table_item_id_1=seq_num_1,table_item_id_2=seq_num_2,...,table_item_id_N=seq_num_N |
The output of this method is the document element ns:changeDeploymentTasksOrderResponse having the structure defined by the following table.
Element | Type | Occurs | Description |
---|---|---|---|
![]() |
1..1 | ||
ns:return | xs:string | 0..1 | service execution message log - empty if everything is successfull |
Name | Content | Description |
---|---|---|
RLMUtilServiceFaultMessage | ns:RLMUtilServiceFaultMessage |
This operation will check if a related field in a table is still available for new related items to be related.
urn:checkRelatedItemMaxLimits
Document
The input of this method is the document element ns:checkRelatedItemMaxLimits having the structure defined by the following table.
Element | Type | Occurs | Description |
---|---|---|---|
![]() |
1..1 | ||
ns:auth | ns:AuthInfo | 0..1 | Authentication information |
ns:table | xs:string | 0..1 | Name of the table |
ns:relatedField | xs:string | 0..1 | Name of the field which should be updated with provided item ID value |
ns:itemId | xs:string | 0..1 | Identifier of item record |
ns:childrenIds | xs:string | 0..1 | Identifiers of children records that should be related to a specified item |
The output of this method is the document element ns:checkRelatedItemMaxLimitsResponse having the structure defined by the following table.
Element | Type | Occurs | Description |
---|---|---|---|
![]() |
1..1 | ||
ns:relatedItemStillAvailable | xs:boolean | 0..1 | Indicator if the related item is still available. |
ns:return | xs:string | 0..1 | Message |
Name | Content | Description |
---|---|---|
RLMUtilServiceFaultMessage | ns:RLMUtilServiceFaultMessage |
Copy related application releases from input release train into target release train with or without release packages info
urn:copyAppReleases2ReleaseTrain
Document
The input of this method is the document element ns:copyAppReleases2ReleaseTrain having the structure defined by the following table.
Element | Type | Occurs | Description |
---|---|---|---|
![]() |
1..1 | ||
ns:auth | ns:AuthInfo | 0..1 | Authentication information |
ns:inputReleaseTrainItemId | xs:string | 0..1 | Identificator of input release train which application releases should be copied from |
ns:targetReleaseTrainItemId | xs:string | 0..1 | Identificator of target release train which application releases should be copied to |
ns:namePrefix | xs:string | 0..1 | Name prefix to make names of new application releases copies to be unique. |
ns:copyPackagesInfo | xs:boolean | 0..1 | Whether to copy or not release packages from copied application releases. Default - false. |
The output of this method is the document element ns:copyAppReleases2ReleaseTrainResponse having the structure defined by the following table.
Element | Type | Occurs | Description |
---|---|---|---|
![]() |
1..1 | ||
ns:return | xs:string | 0..1 | service execution message log - empty if everything is successfull |
Name | Content | Description |
---|---|---|
RLMUtilServiceFaultMessage | ns:RLMUtilServiceFaultMessage |
Copy deployment tasks from specified template into specified release package
urn:copyDeploymentTasks2ReleasePackage
Document
The input of this method is the document element ns:copyDeploymentTasks2ReleasePackage having the structure defined by the following table.
Element | Type | Occurs | Description |
---|---|---|---|
![]() |
1..1 | ||
ns:auth | ns:AuthInfo | 0..1 | Authentication information |
ns:inputReleaseTemplateItemId | xs:string | 0..1 | Identificator of source deployment process template- where tasks will be copied from. |
ns:targetReleasePackageItemId | xs:string | 0..1 | Identificator of target release package - where tasks will be copied to. |
The output of this method is the document element ns:copyDeploymentTasks2ReleasePackageResponse having the structure defined by the following table.
Element | Type | Occurs | Description |
---|---|---|---|
![]() |
1..1 | ||
ns:return | xs:string | 0..1 | service execution message log - empty if everything is successfull |
Name | Content | Description |
---|---|---|
RLMUtilServiceFaultMessage | ns:RLMUtilServiceFaultMessage |
Copy deployment tasks for specified release package in specified state to specified template
urn:copyDeploymentTasks2Template
Document
The input of this method is the document element ns:copyDeploymentTasks2Template having the structure defined by the following table.
Element | Type | Occurs | Description |
---|---|---|---|
![]() |
1..1 | ||
ns:auth | ns:AuthInfo | 0..1 | Authentication information |
ns:inputReleasePackageItemId | xs:string | 0..1 | Identificator of release package which tasks we should copy from |
ns:inputStageId | xs:string | 0..1 | Identificator of stage which tasks we should copy from |
ns:inputReleaseTemplateItemId | xs:string | 0..1 | Identificator of template which we should use to copy tasks from |
ns:targetReleaseTemplateItemId | xs:string | 0..1 | Identificator of template which we should use to copy tasks to |
ns:targetTemplateStageId | xs:string | 0..1 | Identificator of stage which we should use to assign all copied tasks |
The output of this method is the document element ns:copyDeploymentTasks2TemplateResponse having the structure defined by the following table.
Element | Type | Occurs | Description |
---|---|---|---|
![]() |
1..1 | ||
ns:return | xs:string | 0..1 | service execution message log - empty if everything is successfull |
Name | Content | Description |
---|---|---|
RLMUtilServiceFaultMessage | ns:RLMUtilServiceFaultMessage |
Delete deployment tasks either for deployment process template or for release package and optional stage.
urn:deleteDeploymentTasks
Document
The input of this method is the document element ns:deleteDeploymentTasks having the structure defined by the following table.
Element | Type | Occurs | Description |
---|---|---|---|
![]() |
1..1 | ||
ns:auth | ns:AuthInfo | 0..1 | Authentication information. |
ns:releaseTemplateItemId | xs:string | 0..1 | Identificator of deployment process template. |
ns:releasePackageItemId | xs:string | 0..1 | Identificator of release package. |
ns:stageId | xs:string | 0..1 | Identificator of stage. |
ns:taskIds | xs:string | 0..1 | Identificators of tasks to be deleted, separated by commas. |
The output of this method is the document element ns:deleteDeploymentTasksResponse having the structure defined by the following table.
Element | Type | Occurs | Description |
---|---|---|---|
![]() |
1..1 | ||
ns:return | xs:string | 0..1 | service execution message log - empty if everything is successfull |
Name | Content | Description |
---|---|---|
RLMUtilServiceFaultMessage | ns:RLMUtilServiceFaultMessage |
This operation manages the release package deployment process.
urn:deployReleasePackage
Document
The input of this method is the document element ns:deployReleasePackage having the structure defined by the following table.
Element | Type | Occurs | Description |
---|---|---|---|
![]() |
1..1 | ||
ns:authInfo | ns:AuthInfo | 0..1 | Authentication information |
ns:releasePackageItemID | xs:string | 1..1 | Item identifier of release package (in form of table_id:record_id, for example 1001:11) |
ns:options | ns:deployOptions | 1..1 | Either to run or just check deploy status |
ns:releasePackageDeployState | xs:string | 0..1 | State of deployment for release package. If this is not specified, it will default to the current state of the release package. |
ns:sequenceType | ns:SequenceTypes | 1..1 | Either current, next, or previous sequence should be run/checked. |
ns:sequenceNumber | xs:integer | 0..1 | Number of sequence to run/check. |
The output of this method is the document element ns:deployReleasePackageResponse having the structure defined by the following table.
Element | Type | Occurs | Description |
---|---|---|---|
![]() |
1..1 | ||
ns:totalDeployCount | xs:integer | 0..1 | Count of deployment tasks that will be started in this run/check |
ns:currentSequence | xs:integer | 0..1 | Currently processing sequence number |
ns:message | xs:string | 0..1 | Message related to result, such as an error message |
Name | Content | Description |
---|---|---|
RLMUtilServiceFaultMessage | ns:RLMUtilServiceFaultMessage |
This operation initiates the deployment of Dimensions CM Vault Task and Nolio Automation Task.
This could also drive the deployment of the ZMF Vault task or any supported 3rd Party vault system.
urn:deployTask
Document
The input of this method is the document element ns:deployTask having the structure defined by the following table.
Element | Type | Occurs | Description |
---|---|---|---|
![]() |
1..1 | ||
ns:authInfo | ns:AuthInfo | 0..1 | Authentication information |
ns:taskItemId | xs:string | 0..1 | Item identifier of deployment task (in form of table_id:record_id, for example 1001:11) |
The output of this method is the document element ns:deployTaskResponse having the structure defined by the following table.
Element | Type | Occurs | Description |
---|---|---|---|
![]() |
1..1 | ||
ns:return | xs:boolean | 0..1 | Returns true if deploy was successful |
ns:message | xs:string | 0..1 | Message related to result, such as an error message |
Name | Content | Description |
---|---|---|
RLMUtilServiceFaultMessage | ns:RLMUtilServiceFaultMessage |
Move the release package into the failed state by using transition that is assigned in FailedDeployTransition.
urn:failReleasePackage
Document
The input of this method is the document element ns:failReleasePackage having the structure defined by the following table.
Element | Type | Occurs | Description |
---|---|---|---|
![]() |
1..1 | ||
ns:authInfo | ns:AuthInfo | 0..1 | Authentication information |
ns:releasePackageItemID | xs:string | 0..1 | Item identifier of release package (in form of table_id:record_id, for example 1001:11) |
ns:message | xs:string | 0..1 | Error message |
The output of this method is the document element ns:failReleasePackageResponse having the structure defined by the following table.
Element | Type | Occurs | Description |
---|---|---|---|
![]() |
1..1 | ||
ns:return | xs:boolean | 0..1 | Returns true if transition was successful |
Name | Content | Description |
---|---|---|
RLMUtilServiceFaultMessage | ns:RLMUtilServiceFaultMessage |
Returns build version for RLM Utility web service
urn:getBuildVersion
Document
The output of this method is the document element ns:getBuildVersionResponse having the structure defined by the following table.
Element | Type | Occurs | Description |
---|---|---|---|
![]() |
1..1 | ||
ns:return | xs:string | 0..1 | Build version number |
Name | Content | Description |
---|---|---|
RLMUtilServiceFaultMessage | ns:RLMUtilServiceFaultMessage |
Returns interface version number.
urn:getInterfaceVersion
Document
The output of this method is the document element ns:getInterfaceVersionResponse having the structure defined by the following table.
Element | Type | Occurs | Description |
---|---|---|---|
![]() |
1..1 | ||
ns:return | xs:string | 0..1 | Interface version number |
Name | Content | Description |
---|---|---|
RLMUtilServiceFaultMessage | ns:RLMUtilServiceFaultMessage |
This operation initiates the promotion of Dimensions CM Vault Task to a specified target stage area.
In the future, this should also be able to drive the promotion of the ZMF Vault task or any supported 3rd Party vault system.
urn:promoteVaultTask
Document
The input of this method is the document element ns:promoteVaultTask having the structure defined by the following table.
Element | Type | Occurs | Description |
---|---|---|---|
![]() |
1..1 | ||
ns:authInfo | ns:AuthInfo | 0..1 | Authentication information |
ns:taskItemId | xs:string | 1..1 | Item identifier of deployment task (in form of table_id:record_id, for example 1001:11) |
The output of this method is the document element ns:promoteVaultTaskResponse having the structure defined by the following table.
Element | Type | Occurs | Description |
---|---|---|---|
![]() |
1..1 | ||
ns:return | xs:boolean | 0..1 | Returns true if vault task has been promoted successfully |
ns:message | xs:string | 0..1 | Message related to result, such as an error message |
Name | Content | Description |
---|---|---|
RLMUtilServiceFaultMessage | ns:RLMUtilServiceFaultMessage |
This operation relates children records by setting their parent field to specified parent ID value.
urn:relateChildrenRecords
Document
The input of this method is the document element ns:relateChildrenRecords having the structure defined by the following table.
Element | Type | Occurs | Description |
---|---|---|---|
![]() |
1..1 | ||
ns:auth | ns:AuthInfo | 0..1 | Authentication information |
ns:table | xs:string | 0..1 | Name of the table |
ns:transition | xs:string | 0..1 | Name of the update transition |
ns:field | xs:string | 0..1 | Name of the field which should be updated with provided parent ID value |
ns:parentId | xs:string | 0..1 | Identifier of parent record |
ns:childrenIds | xs:string | 0..1 | Identifiers of children records that should be related to a specified parent |
The output of this method is the document element ns:relateChildrenRecordsResponse having the structure defined by the following table.
Element | Type | Occurs | Description |
---|---|---|---|
![]() |
1..1 | ||
ns:return | xs:string | 0..1 | Identifiers of children records that were updated, separated by commas |
Name | Content | Description |
---|---|---|
RLMUtilServiceFaultMessage | ns:RLMUtilServiceFaultMessage |
This operation relates children records to the parent table by setting the children field values specified in the child IDs value.
urn:relateChildrenRecordsToParent
Document
The input of this method is the document element ns:relateChildrenRecordsToParent having the structure defined by the following table.
Element | Type | Occurs | Description |
---|---|---|---|
![]() |
1..1 | ||
ns:auth | ns:AuthInfo | 0..1 | Authentication information |
ns:table | xs:string | 0..1 | Name of the table |
ns:transition | xs:string | 0..1 | Name of the update transition |
ns:field | xs:string | 0..1 | Name of the field which should be updated with provided parent ID value |
ns:parentId | xs:string | 0..1 | Identifier of parent record |
ns:childrenIds | xs:string | 0..1 | Identifiers of children records that should be related to a specified parent |
ns:appendChildrenIds | xs:boolean | 0..1 | Indicator to append the children. Setting this to false will replace the parent related field. |
The output of this method is the document element ns:relateChildrenRecordsToParentResponse having the structure defined by the following table.
Element | Type | Occurs | Description |
---|---|---|---|
![]() |
1..1 | ||
ns:related | xs:boolean | 0..1 | Indicator if the records were related successfully |
ns:return | xs:string | 0..1 | Identifiers of children records that were updated, separated by commas |
Name | Content | Description |
---|---|---|
RLMUtilServiceFaultMessage | ns:RLMUtilServiceFaultMessage |
Relates specified records for 2 tables in both directions. Usually there is a multi-relational field in a parent record and a single-relational field in a child record.
urn:relateRecordsInBothDirections
Document
The input of this method is the document element ns:relateRecordsInBothDirections having the structure defined by the following table.
Element | Type | Occurs | Description |
---|---|---|---|
![]() |
1..1 | ||
ns:auth | ns:AuthInfo | 0..1 | Authentication information |
ns:parentDBTable | xs:string | 0..1 | Name of parent database table |
ns:parentDBField | xs:string | 0..1 | Name of field in parent database table |
ns:childDBTable | xs:string | 0..1 | Name of child database table |
ns:childDBField | xs:string | 0..1 | Name of field in child database table |
ns:parentId | xs:string | 0..1 | Identifier of parent record |
ns:childrenIds | xs:string | 0..1 | List of identifiers of children records separated by commas |
ns:appendChildrenIds | xs:boolean | 0..1 | Indicator to append the children. Setting this to false will replace the parent related field. |
The output of this method is the document element ns:relateRecordsInBothDirectionsResponse having the structure defined by the following table.
Element | Type | Occurs | Description |
---|---|---|---|
![]() |
1..1 | ||
ns:related | xs:boolean | 0..1 | Indicator if the records were related successfully |
ns:return | xs:string | 0..1 | List of related children IDs separated by commas |
Name | Content | Description |
---|---|---|
RLMUtilServiceFaultMessage | ns:RLMUtilServiceFaultMessage |
This operation un-relates children records by setting empty values in their parent field.
urn:unrelateChildrenRecords
Document
The input of this method is the document element ns:unrelateChildrenRecords having the structure defined by the following table.
Element | Type | Occurs | Description |
---|---|---|---|
![]() |
1..1 | ||
ns:auth | ns:AuthInfo | 0..1 | Authentication information |
ns:table | xs:string | 0..1 | Name of the table |
ns:transition | xs:string | 0..1 | Name of the update transition |
ns:field | xs:string | 0..1 | Name of the field which should be emptied |
ns:childrenIds | xs:string | 0..1 | Identifiers of records which should be unrelated |
The output of this method is the document element ns:unrelateChildrenRecordsResponse having the structure defined by the following table.
Element | Type | Occurs | Description |
---|---|---|---|
![]() |
1..1 | ||
ns:return | xs:string | 0..1 | List of unrelated IDs separated by commas |
Name | Content | Description |
---|---|---|
RLMUtilServiceFaultMessage | ns:RLMUtilServiceFaultMessage |
This operation un-relates children records by setting empty values in their parent field.
urn:unrelateChildrenRecordsFromParent
Document
The input of this method is the document element ns:unrelateChildrenRecordsFromParent having the structure defined by the following table.
Element | Type | Occurs | Description |
---|---|---|---|
![]() |
1..1 | ||
ns:auth | ns:AuthInfo | 0..1 | Authentication information |
ns:table | xs:string | 0..1 | Name of the table |
ns:transition | xs:string | 0..1 | Name of the update transition |
ns:field | xs:string | 0..1 | Name of the field which should be emptied |
ns:parentId | xs:string | 0..1 | Identifier of parent record |
ns:childrenIds | xs:string | 0..1 | Identifiers of records which should be unrelated |
The output of this method is the document element ns:unrelateChildrenRecordsFromParentResponse having the structure defined by the following table.
Element | Type | Occurs | Description |
---|---|---|---|
![]() |
1..1 | ||
ns:return | xs:string | 0..1 | List of unrelated IDs separated by commas |
Name | Content | Description |
---|---|---|
RLMUtilServiceFaultMessage | ns:RLMUtilServiceFaultMessage |
Un-relates specified records for 2 tables in both directions. Usually, we have a multi-relational field in parent record and a single-relational field in child record.
This method sets empty values for all children records and removes those children from the multi-relational field in the parent record.
urn:unrelateRecordsInBothDirections
Document
The input of this method is the document element ns:unrelateRecordsInBothDirections having the structure defined by the following table.
Element | Type | Occurs | Description |
---|---|---|---|
![]() |
1..1 | ||
ns:auth | ns:AuthInfo | 0..1 | |
ns:parentDBTable | xs:string | 0..1 | Name of parent database table |
ns:parentDBField | xs:string | 0..1 | Name of field in parent database table |
ns:childDBTable | xs:string | 0..1 | Name of child database table |
ns:childDBField | xs:string | 0..1 | Name of field in child database table |
ns:parentId | xs:string | 0..1 | Identifier of parent record |
ns:childrenIds | xs:string | 0..1 | Identifiers of children records separated by commas |
The output of this method is the document element ns:unrelateRecordsInBothDirectionsResponse having the structure defined by the following table.
Element | Type | Occurs | Description |
---|---|---|---|
![]() |
1..1 | ||
ns:return | xs:string | 0..1 | Identifiers of unrelated children records separated by commas |
Name | Content | Description |
---|---|---|
RLMUtilServiceFaultMessage | ns:RLMUtilServiceFaultMessage |
This operation updates the related Deploy Task item status based on the result of the Dimensions CM submitPromoteBaselines or Nolio execution job.
urn:updateDeploymentTaskStatus
Document
The input of this method is the document element ns:updateDeploymentTaskStatus having the structure defined by the following table.
Element | Type | Occurs | Description |
---|---|---|---|
![]() |
1..1 | ||
ns:authInfo | ns:AuthInfo | 0..1 | Authentication information |
ns:taskType | ns:TaskType | 1..1 | Either vault or automation task type |
ns:jobId | xs:string | 1..1 | Identifier of deployment job for vault or execution process for automation |
ns:jobStatus | xs:string | 1..1 | Current status of execution |
ns:jobStatusMessage | xs:string | 0..1 | Message related to provided status of execution |
The output of this method is the document element ns:updateDeploymentTaskStatusResponse having the structure defined by the following table.
Element | Type | Occurs | Description |
---|---|---|---|
![]() |
1..1 | ||
ns:return | xs:boolean | 0..1 | Returns true if update is successful |
ns:message | xs:string | 0..1 | Message related to result, such as an error message |
ns:taskItemId | xs:string | 0..1 | Item identifier of deployment task (in form of table_id:record_id, for example 1001:11) |
ns:releasePackageItemId | xs:string | 0..1 | Item identifier of release package (in form of table_id:record_id, for example 1001:11) |
ns:taskComplete | xs:boolean | 0..1 | Returns true if the task status is in Completed status |
Name | Content | Description |
---|---|---|
RLMUtilServiceFaultMessage | ns:RLMUtilServiceFaultMessage |
This method checks the deployment status of all the tasks related to the release package that is currently being deployed.
If all the related tasks are in “Completed” state, it will move the release package into the state that is assigned in the NextDeployTransition field.
It there is a failure in the deployment process, it will move the release package into the state that is assigned in FailedDeployTransition.
urn:updateReleasePackageDeployStatus
Document
The input of this method is the document element ns:updateReleasePackageDeployStatus having the structure defined by the following table.
Element | Type | Occurs | Description |
---|---|---|---|
![]() |
1..1 | ||
ns:authInfo | ns:AuthInfo | 0..1 | Authentication information |
ns:releasePackageItemID | xs:string | 1..1 | Item identifier of release package (in form of table_id:record_id, for example 1001:11) |
The output of this method is the document element ns:updateReleasePackageDeployStatusResponse having the structure defined by the following table.
Element | Type | Occurs | Description |
---|---|---|---|
![]() |
1..1 | ||
ns:return | xs:boolean | 0..1 | Returns true if update was successful |
ns:message | xs:string | 0..1 | Message related to result, such as an error message. |
Name | Content | Description |
---|---|---|
RLMUtilServiceFaultMessage | ns:RLMUtilServiceFaultMessage |
Validate Application release record before creation. For now it only checks if name and version are unique.
urn:validateApplicationRelease
Document
The input of this method is the document element ns:validateApplicationRelease having the structure defined by the following table.
Element | Type | Occurs | Description |
---|---|---|---|
![]() |
1..1 | ||
ns:auth | ns:AuthInfo | 0..1 | Authentication information |
ns:appRelease | ns:AppReleaseItem | 0..1 | |
The output of this method is the document element ns:validateApplicationReleaseResponse having the structure defined by the following table.
Element | Type | Occurs | Description |
---|---|---|---|
![]() |
1..1 | ||
ns:return | ns:AppReleaseItem | 0..1 | |
Name | Content | Description |
---|---|---|
RLMUtilServiceFaultMessage | ns:RLMUtilServiceFaultMessage |
This operation validates that there are no tasks in the release package that are in “Incomplete” or “Failed” task status.
urn:validateReleasePackageDeploymentTasks
Document
The input of this method is the document element ns:validateReleasePackageDeploymentTasks having the structure defined by the following table.
Element | Type | Occurs | Description |
---|---|---|---|
![]() |
1..1 | ||
ns:auth | ns:AuthInfo | 0..1 | Authentication information |
ns:releasePackageItemID | xs:string | 0..1 | Item identifier of release package (in form of table_id:record_id, for example 1001:11) |
The output of this method is the document element ns:validateReleasePackageDeploymentTasksResponse having the structure defined by the following table.
Element | Type | Occurs | Description |
---|---|---|---|
![]() |
1..1 | ||
ns:return | xs:boolean | 0..1 | Returns true if the task status is in Completed status |
Name | Content | Description |
---|---|---|
RLMUtilServiceFaultMessage | ns:RLMUtilServiceFaultMessage |
Validate release train record before creation. For now it only checks if name is unique.
urn:validateReleaseTrain
Document
The input of this method is the document element ns:validateReleaseTrain having the structure defined by the following table.
Element | Type | Occurs | Description |
---|---|---|---|
![]() |
1..1 | ||
ns:auth | ns:AuthInfo | 0..1 | Authentication information |
ns:releaseTrain | ns:ReleaseTrainItem | 0..1 | |
The output of this method is the document element ns:validateReleaseTrainResponse having the structure defined by the following table.
Element | Type | Occurs | Description |
---|---|---|---|
![]() |
1..1 | ||
ns:return | ns:ReleaseTrainItem | 0..1 | |
Name | Content | Description |
---|---|---|
RLMUtilServiceFaultMessage | ns:RLMUtilServiceFaultMessage |
Name | Description |
---|---|
ns:AppReleaseItem | |
ns:AuthInfo | |
ns:ReleaseTrainItem |
Restricting xs:anyType
Contains elements as defined in the following table.
Component | Type | Occurs | Description |
---|---|---|---|
![]() |
1..1 | ||
ns:name | xs:string | 0..1 | Name of application release |
ns:version | xs:string | 0..1 | Version of application release |
Restricting xs:anyType
Contains elements as defined in the following table.
Component | Type | Occurs | Description |
---|---|---|---|
![]() |
1..1 | ||
ns:username | xs:string | 0..1 | Name of authenticating user |
ns:password | xs:string | 0..1 | Password of authenticating user |
Restricting xs:anyType
Contains elements as defined in the following table.
Component | Type | Occurs | Description |
---|---|---|---|
![]() |
1..1 | ||
ns:code | xs:string | 0..1 | Code of release train |
ns:name | xs:string | 0..1 | Name of release train |
ns:type | xs:string | 0..1 | Type of release train |
Name | Description |
---|---|
ns:deployOptions | |
ns:SequenceTypes | |
ns:TaskType |
Restricting xs:string
Value | Description |
---|---|
RUN | |
CHECK | |
CHECKRUN |
Restricting xs:string
Value | Description |
---|---|
CURRENT | |
NEXT | |
PREVIOUS | |
LAST |
Restricting xs:string
Value | Description |
---|---|
Vault | |
Automation |
Indicator to append the children. Setting this to false will replace the parent related field.
Type xs:boolean
Element ns:relateChildrenRecordsToParent
Indicator to append the children. Setting this to false will replace the parent related field.
Type xs:boolean
Element ns:relateRecordsInBothDirections
Type ns:AppReleaseItem
Contains elements as defined in the following table.
Component | Type | Occurs | Description |
---|---|---|---|
![]() |
1..1 | ||
ns:name | xs:string | 0..1 | Name of application release |
ns:version | xs:string | 0..1 | Version of application release |
Element ns:validateApplicationRelease
Authentication information
Type ns:AuthInfo
Contains elements as defined in the following table.
Component | Type | Occurs | Description |
---|---|---|---|
![]() |
1..1 | ||
ns:username | xs:string | 0..1 | Name of authenticating user |
ns:password | xs:string | 0..1 | Password of authenticating user |
Element ns:changeDeploymentTasksOrder
Authentication information
Type ns:AuthInfo
Contains elements as defined in the following table.
Component | Type | Occurs | Description |
---|---|---|---|
![]() |
1..1 | ||
ns:username | xs:string | 0..1 | Name of authenticating user |
ns:password | xs:string | 0..1 | Password of authenticating user |
Element ns:checkRelatedItemMaxLimits
Authentication information
Type ns:AuthInfo
Contains elements as defined in the following table.
Component | Type | Occurs | Description |
---|---|---|---|
![]() |
1..1 | ||
ns:username | xs:string | 0..1 | Name of authenticating user |
ns:password | xs:string | 0..1 | Password of authenticating user |
Element ns:copyAppReleases2ReleaseTrain
Authentication information
Type ns:AuthInfo
Contains elements as defined in the following table.
Component | Type | Occurs | Description |
---|---|---|---|
![]() |
1..1 | ||
ns:username | xs:string | 0..1 | Name of authenticating user |
ns:password | xs:string | 0..1 | Password of authenticating user |
Authentication information
Type ns:AuthInfo
Contains elements as defined in the following table.
Component | Type | Occurs | Description |
---|---|---|---|
![]() |
1..1 | ||
ns:username | xs:string | 0..1 | Name of authenticating user |
ns:password | xs:string | 0..1 | Password of authenticating user |
Element ns:copyDeploymentTasks2Template
Authentication information.
Type ns:AuthInfo
Contains elements as defined in the following table.
Component | Type | Occurs | Description |
---|---|---|---|
![]() |
1..1 | ||
ns:username | xs:string | 0..1 | Name of authenticating user |
ns:password | xs:string | 0..1 | Password of authenticating user |
Element ns:deleteDeploymentTasks
Authentication information
Type ns:AuthInfo
Contains elements as defined in the following table.
Component | Type | Occurs | Description |
---|---|---|---|
![]() |
1..1 | ||
ns:username | xs:string | 0..1 | Name of authenticating user |
ns:password | xs:string | 0..1 | Password of authenticating user |
Element ns:relateChildrenRecords
Authentication information
Type ns:AuthInfo
Contains elements as defined in the following table.
Component | Type | Occurs | Description |
---|---|---|---|
![]() |
1..1 | ||
ns:username | xs:string | 0..1 | Name of authenticating user |
ns:password | xs:string | 0..1 | Password of authenticating user |
Element ns:relateChildrenRecordsToParent
Authentication information
Type ns:AuthInfo
Contains elements as defined in the following table.
Component | Type | Occurs | Description |
---|---|---|---|
![]() |
1..1 | ||
ns:username | xs:string | 0..1 | Name of authenticating user |
ns:password | xs:string | 0..1 | Password of authenticating user |
Element ns:relateRecordsInBothDirections
Authentication information
Type ns:AuthInfo
Contains elements as defined in the following table.
Component | Type | Occurs | Description |
---|---|---|---|
![]() |
1..1 | ||
ns:username | xs:string | 0..1 | Name of authenticating user |
ns:password | xs:string | 0..1 | Password of authenticating user |
Element ns:unrelateChildrenRecords
Authentication information
Type ns:AuthInfo
Contains elements as defined in the following table.
Component | Type | Occurs | Description |
---|---|---|---|
![]() |
1..1 | ||
ns:username | xs:string | 0..1 | Name of authenticating user |
ns:password | xs:string | 0..1 | Password of authenticating user |
Type ns:AuthInfo
Contains elements as defined in the following table.
Component | Type | Occurs | Description |
---|---|---|---|
![]() |
1..1 | ||
ns:username | xs:string | 0..1 | Name of authenticating user |
ns:password | xs:string | 0..1 | Password of authenticating user |
Authentication information
Type ns:AuthInfo
Contains elements as defined in the following table.
Component | Type | Occurs | Description |
---|---|---|---|
![]() |
1..1 | ||
ns:username | xs:string | 0..1 | Name of authenticating user |
ns:password | xs:string | 0..1 | Password of authenticating user |
Element ns:validateApplicationRelease
Authentication information
Type ns:AuthInfo
Contains elements as defined in the following table.
Component | Type | Occurs | Description |
---|---|---|---|
![]() |
1..1 | ||
ns:username | xs:string | 0..1 | Name of authenticating user |
ns:password | xs:string | 0..1 | Password of authenticating user |
Authentication information
Type ns:AuthInfo
Contains elements as defined in the following table.
Component | Type | Occurs | Description |
---|---|---|---|
![]() |
1..1 | ||
ns:username | xs:string | 0..1 | Name of authenticating user |
ns:password | xs:string | 0..1 | Password of authenticating user |
Element ns:validateReleaseTrain
Authentication information
Type ns:AuthInfo
Contains elements as defined in the following table.
Component | Type | Occurs | Description |
---|---|---|---|
![]() |
1..1 | ||
ns:username | xs:string | 0..1 | Name of authenticating user |
ns:password | xs:string | 0..1 | Password of authenticating user |
Element ns:deployReleasePackage
Authentication information
Type ns:AuthInfo
Contains elements as defined in the following table.
Component | Type | Occurs | Description |
---|---|---|---|
![]() |
1..1 | ||
ns:username | xs:string | 0..1 | Name of authenticating user |
ns:password | xs:string | 0..1 | Password of authenticating user |
Element ns:deployTask
Authentication information
Type ns:AuthInfo
Contains elements as defined in the following table.
Component | Type | Occurs | Description |
---|---|---|---|
![]() |
1..1 | ||
ns:username | xs:string | 0..1 | Name of authenticating user |
ns:password | xs:string | 0..1 | Password of authenticating user |
Element ns:failReleasePackage
Authentication information
Type ns:AuthInfo
Contains elements as defined in the following table.
Component | Type | Occurs | Description |
---|---|---|---|
![]() |
1..1 | ||
ns:username | xs:string | 0..1 | Name of authenticating user |
ns:password | xs:string | 0..1 | Password of authenticating user |
Element ns:promoteVaultTask
Authentication information
Type ns:AuthInfo
Contains elements as defined in the following table.
Component | Type | Occurs | Description |
---|---|---|---|
![]() |
1..1 | ||
ns:username | xs:string | 0..1 | Name of authenticating user |
ns:password | xs:string | 0..1 | Password of authenticating user |
Element ns:updateDeploymentTaskStatus
Authentication information
Type ns:AuthInfo
Contains elements as defined in the following table.
Component | Type | Occurs | Description |
---|---|---|---|
![]() |
1..1 | ||
ns:username | xs:string | 0..1 | Name of authenticating user |
ns:password | xs:string | 0..1 | Password of authenticating user |
Restricting xs:anyType
Contains elements as defined in the following table.
Component | Type | Occurs | Description |
---|---|---|---|
![]() |
1..1 | ||
ns:auth | ns:AuthInfo | 0..1 | Authentication information |
ns:tasksOrderInfo | xs:string | 0..1 | Tasks ids and order pairs separated by commas. In form of table_item_id_1=seq_num_1,table_item_id_2=seq_num_2,...,table_item_id_N=seq_num_N |
Restricting xs:anyType
Contains elements as defined in the following table.
Component | Type | Occurs | Description |
---|---|---|---|
![]() |
1..1 | ||
ns:return | xs:string | 0..1 | service execution message log - empty if everything is successfull |
Authentication information
Restricting xs:anyType
Contains elements as defined in the following table.
Component | Type | Occurs | Description |
---|---|---|---|
![]() |
1..1 | ||
ns:auth | ns:AuthInfo | 0..1 | Authentication information |
ns:table | xs:string | 0..1 | Name of the table |
ns:relatedField | xs:string | 0..1 | Name of the field which should be updated with provided item ID value |
ns:itemId | xs:string | 0..1 | Identifier of item record |
ns:childrenIds | xs:string | 0..1 | Identifiers of children records that should be related to a specified item |
Restricting xs:anyType
Contains elements as defined in the following table.
Component | Type | Occurs | Description |
---|---|---|---|
![]() |
1..1 | ||
ns:relatedItemStillAvailable | xs:boolean | 0..1 | Indicator if the related item is still available. |
ns:return | xs:string | 0..1 | Message |
Name of field in child database table
Type xs:string
Element ns:relateRecordsInBothDirections
Name of field in child database table
Type xs:string
Name of child database table
Type xs:string
Element ns:relateRecordsInBothDirections
Name of child database table
Type xs:string
Identifiers of children records that should be related to a specified item
Type xs:string
Element ns:checkRelatedItemMaxLimits
Identifiers of children records that should be related to a specified parent
Type xs:string
Element ns:relateChildrenRecords
Identifiers of children records that should be related to a specified parent
Type xs:string
Element ns:relateChildrenRecordsToParent
List of identifiers of children records separated by commas
Type xs:string
Element ns:relateRecordsInBothDirections
Identifiers of records which should be unrelated
Type xs:string
Element ns:unrelateChildrenRecords
Identifiers of records which should be unrelated
Type xs:string
Identifiers of children records separated by commas
Type xs:string
Code of release train
Type xs:string
Complex Type ns:ReleaseTrainItem
Restricting xs:anyType
Contains elements as defined in the following table.
Component | Type | Occurs | Description |
---|---|---|---|
![]() |
1..1 | ||
ns:auth | ns:AuthInfo | 0..1 | Authentication information |
ns:inputReleaseTrainItemId | xs:string | 0..1 | Identificator of input release train which application releases should be copied from |
ns:targetReleaseTrainItemId | xs:string | 0..1 | Identificator of target release train which application releases should be copied to |
ns:namePrefix | xs:string | 0..1 | Name prefix to make names of new application releases copies to be unique. |
ns:copyPackagesInfo | xs:boolean | 0..1 | Whether to copy or not release packages from copied application releases. Default - false. |
Restricting xs:anyType
Contains elements as defined in the following table.
Component | Type | Occurs | Description |
---|---|---|---|
![]() |
1..1 | ||
ns:return | xs:string | 0..1 | service execution message log - empty if everything is successfull |
Restricting xs:anyType
Contains elements as defined in the following table.
Component | Type | Occurs | Description |
---|---|---|---|
![]() |
1..1 | ||
ns:auth | ns:AuthInfo | 0..1 | Authentication information |
ns:inputReleaseTemplateItemId | xs:string | 0..1 | Identificator of source deployment process template- where tasks will be copied from. |
ns:targetReleasePackageItemId | xs:string | 0..1 | Identificator of target release package - where tasks will be copied to. |
Restricting xs:anyType
Contains elements as defined in the following table.
Component | Type | Occurs | Description |
---|---|---|---|
![]() |
1..1 | ||
ns:return | xs:string | 0..1 | service execution message log - empty if everything is successfull |
Restricting xs:anyType
Contains elements as defined in the following table.
Component | Type | Occurs | Description |
---|---|---|---|
![]() |
1..1 | ||
ns:auth | ns:AuthInfo | 0..1 | Authentication information |
ns:inputReleasePackageItemId | xs:string | 0..1 | Identificator of release package which tasks we should copy from |
ns:inputStageId | xs:string | 0..1 | Identificator of stage which tasks we should copy from |
ns:inputReleaseTemplateItemId | xs:string | 0..1 | Identificator of template which we should use to copy tasks from |
ns:targetReleaseTemplateItemId | xs:string | 0..1 | Identificator of template which we should use to copy tasks to |
ns:targetTemplateStageId | xs:string | 0..1 | Identificator of stage which we should use to assign all copied tasks |
Restricting xs:anyType
Contains elements as defined in the following table.
Component | Type | Occurs | Description |
---|---|---|---|
![]() |
1..1 | ||
ns:return | xs:string | 0..1 | service execution message log - empty if everything is successfull |
Whether to copy or not release packages from copied application releases. Default - false.
Type xs:boolean
Element ns:copyAppReleases2ReleaseTrain
Currently processing sequence number
Type xs:integer
Element ns:deployReleasePackageResponse
Restricting xs:anyType
Contains elements as defined in the following table.
Component | Type | Occurs | Description |
---|---|---|---|
![]() |
1..1 | ||
ns:auth | ns:AuthInfo | 0..1 | Authentication information. |
ns:releaseTemplateItemId | xs:string | 0..1 | Identificator of deployment process template. |
ns:releasePackageItemId | xs:string | 0..1 | Identificator of release package. |
ns:stageId | xs:string | 0..1 | Identificator of stage. |
ns:taskIds | xs:string | 0..1 | Identificators of tasks to be deleted, separated by commas. |
Restricting xs:anyType
Contains elements as defined in the following table.
Component | Type | Occurs | Description |
---|---|---|---|
![]() |
1..1 | ||
ns:return | xs:string | 0..1 | service execution message log - empty if everything is successfull |
Authentication information
Restricting xs:anyType
Contains elements as defined in the following table.
Component | Type | Occurs | Description |
---|---|---|---|
![]() |
1..1 | ||
ns:authInfo | ns:AuthInfo | 0..1 | Authentication information |
ns:releasePackageItemID | xs:string | 1..1 | Item identifier of release package (in form of table_id:record_id, for example 1001:11) |
ns:options | ns:deployOptions | 1..1 | Either to run or just check deploy status |
ns:releasePackageDeployState | xs:string | 0..1 | State of deployment for release package. If this is not specified, it will default to the current state of the release package. |
ns:sequenceType | ns:SequenceTypes | 1..1 | Either current, next, or previous sequence should be run/checked. |
ns:sequenceNumber | xs:integer | 0..1 | Number of sequence to run/check. |
Restricting xs:anyType
Contains elements as defined in the following table.
Component | Type | Occurs | Description |
---|---|---|---|
![]() |
1..1 | ||
ns:totalDeployCount | xs:integer | 0..1 | Count of deployment tasks that will be started in this run/check |
ns:currentSequence | xs:integer | 0..1 | Currently processing sequence number |
ns:message | xs:string | 0..1 | Message related to result, such as an error message |
Restricting xs:anyType
Contains elements as defined in the following table.
Component | Type | Occurs | Description |
---|---|---|---|
![]() |
1..1 | ||
ns:authInfo | ns:AuthInfo | 0..1 | Authentication information |
ns:taskItemId | xs:string | 0..1 | Item identifier of deployment task (in form of table_id:record_id, for example 1001:11) |
Restricting xs:anyType
Contains elements as defined in the following table.
Component | Type | Occurs | Description |
---|---|---|---|
![]() |
1..1 | ||
ns:return | xs:boolean | 0..1 | Returns true if deploy was successful |
ns:message | xs:string | 0..1 | Message related to result, such as an error message |
Restricting xs:anyType
Contains elements as defined in the following table.
Component | Type | Occurs | Description |
---|---|---|---|
![]() |
1..1 | ||
ns:authInfo | ns:AuthInfo | 0..1 | Authentication information |
ns:releasePackageItemID | xs:string | 0..1 | Item identifier of release package (in form of table_id:record_id, for example 1001:11) |
ns:message | xs:string | 0..1 | Error message |
Restricting xs:anyType
Contains elements as defined in the following table.
Component | Type | Occurs | Description |
---|---|---|---|
![]() |
1..1 | ||
ns:return | xs:boolean | 0..1 | Returns true if transition was successful |
Name of the field which should be updated with provided parent ID value
Type xs:string
Element ns:relateChildrenRecords
Name of the field which should be updated with provided parent ID value
Type xs:string
Element ns:relateChildrenRecordsToParent
Name of the field which should be emptied
Type xs:string
Element ns:unrelateChildrenRecords
Name of the field which should be emptied
Type xs:string
Restricting xs:anyType
Contains elements as defined in the following table.
Component | Type | Occurs | Description |
---|---|---|---|
![]() |
1..1 | ||
ns:return | xs:string | 0..1 | Build version number |
Restricting xs:anyType
Contains elements as defined in the following table.
Component | Type | Occurs | Description |
---|---|---|---|
![]() |
1..1 | ||
ns:return | xs:string | 0..1 | Interface version number |
Identificator of release package
which tasks we should copy from
Type xs:string
Element ns:copyDeploymentTasks2Template
Identificator of source deployment process template- where tasks will be copied from.
Type xs:string
Identificator of template which we
should use to copy tasks from
Type xs:string
Element ns:copyDeploymentTasks2Template
Identificator of input release train which application releases should be copied from
Type xs:string
Element ns:copyAppReleases2ReleaseTrain
Identificator of stage which tasks
we should copy from
Type xs:string
Element ns:copyDeploymentTasks2Template
Identifier of item record
Type xs:string
Element ns:checkRelatedItemMaxLimits
Identifier of deployment job for vault or execution process for automation
Type xs:string
Element ns:updateDeploymentTaskStatus
Current status of execution
Type xs:string
Element ns:updateDeploymentTaskStatus
Message related to provided status of execution
Type xs:string
Element ns:updateDeploymentTaskStatus
Message related to result, such as an error message
Type xs:string
Element ns:deployReleasePackageResponse
Message related to result, such as an error message
Type xs:string
Element ns:deployTaskResponse
Message related to result, such as an error message
Type xs:string
Element ns:promoteVaultTaskResponse
Message related to result, such as an error message
Type xs:string
Message related to result, such as an error message.
Type xs:string
Name of application release
Type xs:string
Complex Type ns:AppReleaseItem
Name of release train
Type xs:string
Complex Type ns:ReleaseTrainItem
Name prefix to make names of new application releases copies to be unique.
Type xs:string
Element ns:copyAppReleases2ReleaseTrain
Either to run or just check deploy status
Type ns:deployOptions
Value | Description |
---|---|
RUN | |
CHECK | |
CHECKRUN |
Element ns:deployReleasePackage
Name of field in parent database table
Type xs:string
Element ns:relateRecordsInBothDirections
Name of field in parent database table
Type xs:string
Name of parent database table
Type xs:string
Element ns:relateRecordsInBothDirections
Name of parent database table
Type xs:string
Identifier of parent record
Type xs:string
Element ns:relateChildrenRecords
Identifier of parent record
Type xs:string
Element ns:relateChildrenRecordsToParent
Identifier of parent record
Type xs:string
Element ns:relateRecordsInBothDirections
Identifier of parent record
Type xs:string
Identifier of parent record
Type xs:string
Password of authenticating user
Type xs:string
Complex Type ns:AuthInfo
Restricting xs:anyType
Contains elements as defined in the following table.
Component | Type | Occurs | Description |
---|---|---|---|
![]() |
1..1 | ||
ns:authInfo | ns:AuthInfo | 0..1 | Authentication information |
ns:taskItemId | xs:string | 1..1 | Item identifier of deployment task (in form of table_id:record_id, for example 1001:11) |
Restricting xs:anyType
Contains elements as defined in the following table.
Component | Type | Occurs | Description |
---|---|---|---|
![]() |
1..1 | ||
ns:return | xs:boolean | 0..1 | Returns true if vault task has been promoted successfully |
ns:message | xs:string | 0..1 | Message related to result, such as an error message |
Authentication information
Restricting xs:anyType
Contains elements as defined in the following table.
Component | Type | Occurs | Description |
---|---|---|---|
![]() |
1..1 | ||
ns:auth | ns:AuthInfo | 0..1 | Authentication information |
ns:table | xs:string | 0..1 | Name of the table |
ns:transition | xs:string | 0..1 | Name of the update transition |
ns:field | xs:string | 0..1 | Name of the field which should be updated with provided parent ID value |
ns:parentId | xs:string | 0..1 | Identifier of parent record |
ns:childrenIds | xs:string | 0..1 | Identifiers of children records that should be related to a specified parent |
Restricting xs:anyType
Contains elements as defined in the following table.
Component | Type | Occurs | Description |
---|---|---|---|
![]() |
1..1 | ||
ns:return | xs:string | 0..1 | Identifiers of children records that were updated, separated by commas |
Authentication information
Restricting xs:anyType
Contains elements as defined in the following table.
Component | Type | Occurs | Description |
---|---|---|---|
![]() |
1..1 | ||
ns:auth | ns:AuthInfo | 0..1 | Authentication information |
ns:table | xs:string | 0..1 | Name of the table |
ns:transition | xs:string | 0..1 | Name of the update transition |
ns:field | xs:string | 0..1 | Name of the field which should be updated with provided parent ID value |
ns:parentId | xs:string | 0..1 | Identifier of parent record |
ns:childrenIds | xs:string | 0..1 | Identifiers of children records that should be related to a specified parent |
ns:appendChildrenIds | xs:boolean | 0..1 | Indicator to append the children. Setting this to false will replace the parent related field. |
Restricting xs:anyType
Contains elements as defined in the following table.
Component | Type | Occurs | Description |
---|---|---|---|
![]() |
1..1 | ||
ns:related | xs:boolean | 0..1 | Indicator if the records were related successfully |
ns:return | xs:string | 0..1 | Identifiers of children records that were updated, separated by commas |
Indicator if the records were related successfully
Type xs:boolean
Indicator if the records were related successfully
Type xs:boolean
Name of the field which should be updated with provided item ID value
Type xs:string
Element ns:checkRelatedItemMaxLimits
Indicator if the related item is still available.
Type xs:boolean
Restricting xs:anyType
Contains elements as defined in the following table.
Component | Type | Occurs | Description |
---|---|---|---|
![]() |
1..1 | ||
ns:auth | ns:AuthInfo | 0..1 | Authentication information |
ns:parentDBTable | xs:string | 0..1 | Name of parent database table |
ns:parentDBField | xs:string | 0..1 | Name of field in parent database table |
ns:childDBTable | xs:string | 0..1 | Name of child database table |
ns:childDBField | xs:string | 0..1 | Name of field in child database table |
ns:parentId | xs:string | 0..1 | Identifier of parent record |
ns:childrenIds | xs:string | 0..1 | List of identifiers of children records separated by commas |
ns:appendChildrenIds | xs:boolean | 0..1 | Indicator to append the children. Setting this to false will replace the parent related field. |
Restricting xs:anyType
Contains elements as defined in the following table.
Component | Type | Occurs | Description |
---|---|---|---|
![]() |
1..1 | ||
ns:related | xs:boolean | 0..1 | Indicator if the records were related successfully |
ns:return | xs:string | 0..1 | List of related children IDs separated by commas |
State of deployment for release package. If this is not specified, it will default to the current state of the release package.
Type xs:string
Element ns:deployReleasePackage
Identificator of release package.
Type xs:string
Element ns:deleteDeploymentTasks
Item identifier of release package (in form of table_id:record_id, for example 1001:11)
Type xs:string
Element ns:deployReleasePackage
Item identifier of release package (in form of table_id:record_id, for example 1001:11)
Type xs:string
Element ns:failReleasePackage
Item identifier of release package (in form of table_id:record_id, for example 1001:11)
Type xs:string
Item identifier of release package (in form of table_id:record_id, for example 1001:11)
Type xs:string
Item identifier of release package (in form of table_id:record_id, for example 1001:11)
Type xs:string
Identificator of deployment process template.
Type xs:string
Element ns:deleteDeploymentTasks
Type ns:ReleaseTrainItem
Contains elements as defined in the following table.
Component | Type | Occurs | Description |
---|---|---|---|
![]() |
1..1 | ||
ns:code | xs:string | 0..1 | Code of release train |
ns:name | xs:string | 0..1 | Name of release train |
ns:type | xs:string | 0..1 | Type of release train |
Element ns:validateReleaseTrain
service execution message log - empty if everything is successfull
Type xs:string
Message
Type xs:string
service execution message log - empty if everything is successfull
Type xs:string
service execution message log - empty if everything is successfull
Type xs:string
service execution message log - empty if everything is successfull
Type xs:string
service execution message log - empty if everything is successfull
Type xs:string
Element ns:deleteDeploymentTasksResponse
Returns true if deploy was successful
Type xs:boolean
Element ns:deployTaskResponse
Returns true if transition was successful
Type xs:boolean
Element ns:failReleasePackageResponse
Build version number
Type xs:string
Element ns:getBuildVersionResponse
Interface version number
Type xs:string
Element ns:getInterfaceVersionResponse
Returns true if vault task has been promoted successfully
Type xs:boolean
Element ns:promoteVaultTaskResponse
Identifiers of children records that were updated, separated by commas
Type xs:string
Element ns:relateChildrenRecordsResponse
Identifiers of children records that were updated, separated by commas
Type xs:string
List of related children IDs separated by commas
Type xs:string
List of unrelated IDs separated by commas
Type xs:string
List of unrelated IDs separated by commas
Type xs:string
Identifiers of unrelated children records separated by commas
Type xs:string
Returns true if update is successful
Type xs:boolean
Returns true if update was successful
Type xs:boolean
Type ns:AppReleaseItem
Contains elements as defined in the following table.
Component | Type | Occurs | Description |
---|---|---|---|
![]() |
1..1 | ||
ns:name | xs:string | 0..1 | Name of application release |
ns:version | xs:string | 0..1 | Version of application release |
Returns true if the task status is in Completed status
Type xs:boolean
Type ns:ReleaseTrainItem
Contains elements as defined in the following table.
Component | Type | Occurs | Description |
---|---|---|---|
![]() |
1..1 | ||
ns:code | xs:string | 0..1 | Code of release train |
ns:name | xs:string | 0..1 | Name of release train |
ns:type | xs:string | 0..1 | Type of release train |
Element ns:validateReleaseTrainResponse
Error message
Type xs:string
Element ns:RLMUtilServiceFaultMessage
Restricting xs:anyType
Contains elements as defined in the following table.
Component | Type | Occurs | Description |
---|---|---|---|
![]() |
1..1 | ||
ns:RLMUtilServiceFaultMessage | xs:string | 0..1 | Error message |
Number of sequence to run/check.
Type xs:integer
Element ns:deployReleasePackage
Either current, next, or previous sequence should be run/checked.
Type ns:SequenceTypes
Value | Description |
---|---|
CURRENT | |
NEXT | |
PREVIOUS | |
LAST |
Element ns:deployReleasePackage
Identificator of stage.
Type xs:string
Element ns:deleteDeploymentTasks
Name of the table
Type xs:string
Element ns:checkRelatedItemMaxLimits
Name of the table
Type xs:string
Element ns:relateChildrenRecords
Name of the table
Type xs:string
Element ns:relateChildrenRecordsToParent
Name of the table
Type xs:string
Element ns:unrelateChildrenRecords
Name of the table
Type xs:string
Identificator of target release package - where tasks will be copied to.
Type xs:string
Identificator of template which we
should use to copy tasks to
Type xs:string
Element ns:copyDeploymentTasks2Template
Identificator of target release train which application releases should be copied to
Type xs:string
Element ns:copyAppReleases2ReleaseTrain
Identificator of stage which we
should use to assign all copied tasks
Type xs:string
Element ns:copyDeploymentTasks2Template
Returns true if the task status is in Completed status
Type xs:boolean
Identificators of tasks to be deleted, separated by commas.
Type xs:string
Element ns:deleteDeploymentTasks
Item identifier of deployment task (in form of table_id:record_id, for example 1001:11)
Type xs:string
Element ns:deployTask
Item identifier of deployment task (in form of table_id:record_id, for example 1001:11)
Type xs:string
Element ns:promoteVaultTask
Item identifier of deployment task (in form of table_id:record_id, for example 1001:11)
Type xs:string
Tasks ids and order pairs separated by commas. In form of table_item_id_1=seq_num_1,table_item_id_2=seq_num_2,...,table_item_id_N=seq_num_N
Type xs:string
Element ns:changeDeploymentTasksOrder
Either vault or automation task type
Type ns:TaskType
Value | Description |
---|---|
Vault | |
Automation |
Element ns:updateDeploymentTaskStatus
Count of deployment tasks that will be started in this run/check
Type xs:integer
Element ns:deployReleasePackageResponse
Name of the update transition
Type xs:string
Element ns:relateChildrenRecords
Name of the update transition
Type xs:string
Element ns:relateChildrenRecordsToParent
Name of the update transition
Type xs:string
Element ns:unrelateChildrenRecords
Name of the update transition
Type xs:string
Type of release train
Type xs:string
Complex Type ns:ReleaseTrainItem
Restricting xs:anyType
Contains elements as defined in the following table.
Component | Type | Occurs | Description |
---|---|---|---|
![]() |
1..1 | ||
ns:auth | ns:AuthInfo | 0..1 | Authentication information |
ns:table | xs:string | 0..1 | Name of the table |
ns:transition | xs:string | 0..1 | Name of the update transition |
ns:field | xs:string | 0..1 | Name of the field which should be emptied |
ns:childrenIds | xs:string | 0..1 | Identifiers of records which should be unrelated |
Restricting xs:anyType
Contains elements as defined in the following table.
Component | Type | Occurs | Description |
---|---|---|---|
![]() |
1..1 | ||
ns:auth | ns:AuthInfo | 0..1 | Authentication information |
ns:table | xs:string | 0..1 | Name of the table |
ns:transition | xs:string | 0..1 | Name of the update transition |
ns:field | xs:string | 0..1 | Name of the field which should be emptied |
ns:parentId | xs:string | 0..1 | Identifier of parent record |
ns:childrenIds | xs:string | 0..1 | Identifiers of records which should be unrelated |
Restricting xs:anyType
Contains elements as defined in the following table.
Component | Type | Occurs | Description |
---|---|---|---|
![]() |
1..1 | ||
ns:return | xs:string | 0..1 | List of unrelated IDs separated by commas |
Restricting xs:anyType
Contains elements as defined in the following table.
Component | Type | Occurs | Description |
---|---|---|---|
![]() |
1..1 | ||
ns:return | xs:string | 0..1 | List of unrelated IDs separated by commas |
Authentication information
Restricting xs:anyType
Contains elements as defined in the following table.
Component | Type | Occurs | Description |
---|---|---|---|
![]() |
1..1 | ||
ns:auth | ns:AuthInfo | 0..1 | |
ns:parentDBTable | xs:string | 0..1 | Name of parent database table |
ns:parentDBField | xs:string | 0..1 | Name of field in parent database table |
ns:childDBTable | xs:string | 0..1 | Name of child database table |
ns:childDBField | xs:string | 0..1 | Name of field in child database table |
ns:parentId | xs:string | 0..1 | Identifier of parent record |
ns:childrenIds | xs:string | 0..1 | Identifiers of children records separated by commas |
Restricting xs:anyType
Contains elements as defined in the following table.
Component | Type | Occurs | Description |
---|---|---|---|
![]() |
1..1 | ||
ns:return | xs:string | 0..1 | Identifiers of unrelated children records separated by commas |
Restricting xs:anyType
Contains elements as defined in the following table.
Component | Type | Occurs | Description |
---|---|---|---|
![]() |
1..1 | ||
ns:authInfo | ns:AuthInfo | 0..1 | Authentication information |
ns:taskType | ns:TaskType | 1..1 | Either vault or automation task type |
ns:jobId | xs:string | 1..1 | Identifier of deployment job for vault or execution process for automation |
ns:jobStatus | xs:string | 1..1 | Current status of execution |
ns:jobStatusMessage | xs:string | 0..1 | Message related to provided status of execution |
Restricting xs:anyType
Contains elements as defined in the following table.
Component | Type | Occurs | Description |
---|---|---|---|
![]() |
1..1 | ||
ns:return | xs:boolean | 0..1 | Returns true if update is successful |
ns:message | xs:string | 0..1 | Message related to result, such as an error message |
ns:taskItemId | xs:string | 0..1 | Item identifier of deployment task (in form of table_id:record_id, for example 1001:11) |
ns:releasePackageItemId | xs:string | 0..1 | Item identifier of release package (in form of table_id:record_id, for example 1001:11) |
ns:taskComplete | xs:boolean | 0..1 | Returns true if the task status is in Completed status |
Restricting xs:anyType
Contains elements as defined in the following table.
Component | Type | Occurs | Description |
---|---|---|---|
![]() |
1..1 | ||
ns:authInfo | ns:AuthInfo | 0..1 | Authentication information |
ns:releasePackageItemID | xs:string | 1..1 | Item identifier of release package (in form of table_id:record_id, for example 1001:11) |
Restricting xs:anyType
Contains elements as defined in the following table.
Component | Type | Occurs | Description |
---|---|---|---|
![]() |
1..1 | ||
ns:return | xs:boolean | 0..1 | Returns true if update was successful |
ns:message | xs:string | 0..1 | Message related to result, such as an error message. |
Name of authenticating user
Type xs:string
Complex Type ns:AuthInfo
Authentication information
Restricting xs:anyType
Contains elements as defined in the following table.
Component | Type | Occurs | Description |
---|---|---|---|
![]() |
1..1 | ||
ns:auth | ns:AuthInfo | 0..1 | Authentication information |
ns:appRelease | ns:AppReleaseItem | 0..1 | |
Restricting xs:anyType
Contains elements as defined in the following table.
Component | Type | Occurs | Description |
---|---|---|---|
![]() |
1..1 | ||
ns:return | ns:AppReleaseItem | 0..1 | |
Restricting xs:anyType
Contains elements as defined in the following table.
Component | Type | Occurs | Description |
---|---|---|---|
![]() |
1..1 | ||
ns:auth | ns:AuthInfo | 0..1 | Authentication information |
ns:releasePackageItemID | xs:string | 0..1 | Item identifier of release package (in form of table_id:record_id, for example 1001:11) |
Restricting xs:anyType
Contains elements as defined in the following table.
Component | Type | Occurs | Description |
---|---|---|---|
![]() |
1..1 | ||
ns:return | xs:boolean | 0..1 | Returns true if the task status is in Completed status |
Restricting xs:anyType
Contains elements as defined in the following table.
Component | Type | Occurs | Description |
---|---|---|---|
![]() |
1..1 | ||
ns:auth | ns:AuthInfo | 0..1 | Authentication information |
ns:releaseTrain | ns:ReleaseTrainItem | 0..1 | |
Restricting xs:anyType
Contains elements as defined in the following table.
Component | Type | Occurs | Description |
---|---|---|---|
![]() |
1..1 | ||
ns:return | ns:ReleaseTrainItem | 0..1 | |
Version of application release
Type xs:string
Complex Type ns:AppReleaseItem
Serena Release Manager Release Request Service
SOAP
Document
Name | Description |
---|---|
createDevTaskRequest | Create a new request for a specified dev task |
delegateDevTaskRequest | Delegate request to a user |
executeSSMTransition | |
getBcrRequests | |
getBuildVersion | Returns build version for Release Requests web service |
getInterfaceVersion | Returns interface version for Release Requests web service |
getRelatedBcrRequests | |
getRelatedRequestProjects | Returns related projects for a specified release package |
getRelatedRequests | Returns related requests for specified release package |
getRelatedRfcRequests | |
getRequestProjects | Returns projects |
getRequests | Returns requests from registered request providers. |
getRfcRequests | |
relateBcrRequests | |
relateRequestProjects | Relates specified project to specified release package |
relateRequests | Relates specified requests to specified release package |
relateRfcRequests | |
unRelateBcrRequests | |
unRelateRequestProjects | Un-relates specified project from specified release package |
unRelateRequests | Un-relates specified request from specified release package |
unRelateRfcRequests | |
updateDevTaskRequest | Update request for a specified dev task |
Create a new request for a specified dev task
urn:createDevTaskRequest
Document
The input of this method is the document element ns:createDevTaskRequest having the structure defined by the following table.
Element | Type | Occurs | Description |
---|---|---|---|
![]() |
1..1 | ||
ns:designMode | xs:boolean | 0..1 | Enable design mode if set to true. |
ns:auth | ns:AuthInfo | 0..1 | Authentication information |
ns:devTaskId | xs:string | 1..1 | Dev task ID |
ns:providerName | xs:string | 0..1 | Name of provider |
The output of this method is the document element ns:createDevTaskRequestResponse having the structure defined by the following table.
Element | Type | Occurs | Description |
---|---|---|---|
![]() |
1..1 | ||
ns:return | ns:RequestInfo | 0..* | |
Name | Content | Description |
---|---|---|
ReleaseRequestServiceException | ns:ReleaseRequestServiceException |
Delegate request to a user
urn:delegateDevTaskRequest
Document
The input of this method is the document element ns:delegateDevTaskRequest having the structure defined by the following table.
Element | Type | Occurs | Description |
---|---|---|---|
![]() |
1..1 | ||
ns:designMode | xs:boolean | 0..1 | Enable design mode if set to true. |
ns:auth | ns:AuthInfo | 0..1 | Authentication information |
ns:devTaskId | xs:string | 1..1 | Dev task ID |
ns:providerName | xs:string | 0..1 | Name of provider |
The output of this method is the document element ns:delegateDevTaskRequestResponse having the structure defined by the following table.
Element | Type | Occurs | Description |
---|---|---|---|
![]() |
1..1 | ||
ns:return | ns:RequestInfo | 0..* | |
Name | Content | Description |
---|---|---|
ReleaseRequestServiceException | ns:ReleaseRequestServiceException |
urn:executeSSMTransition
Document
The input of this method is the document element ns:executeSSMTransition having the structure defined by the following table.
Element | Type | Occurs | Description |
---|---|---|---|
![]() |
1..1 | ||
ns:auth | ns:AuthInfo | 0..1 | |
ns:rtId | xs:string | 0..1 | |
ns:transition | xs:string | 0..1 | |
ns:requestIds | xs:string | 0..1 | |
The output of this method is the document element ns:executeSSMTransitionResponse having the structure defined by the following table.
Element | Type | Occurs | Description |
---|---|---|---|
![]() |
1..1 | ||
ns:return | ns:RfcRequestInfo | 0..* | |
Name | Content | Description |
---|---|---|
ReleaseRequestServiceException | ns:ReleaseRequestServiceException |
urn:getBcrRequests
Document
The input of this method is the document element ns:getBcrRequests having the structure defined by the following table.
Element | Type | Occurs | Description |
---|---|---|---|
![]() |
1..1 | ||
ns:designMode | xs:boolean | 0..1 | |
ns:auth | ns:AuthInfo | 0..1 | |
ns:filter | xs:string | 0..1 | |
The output of this method is the document element ns:getBcrRequestsResponse having the structure defined by the following table.
Element | Type | Occurs | Description |
---|---|---|---|
![]() |
1..1 | ||
ns:return | ns:BcrRequestInfo | 0..* | |
Name | Content | Description |
---|---|---|
ReleaseRequestServiceException | ns:ReleaseRequestServiceException |
Returns build version for Release Requests web service
urn:getBuildVersion
Document
The output of this method is the document element ns:getBuildVersionResponse having the structure defined by the following table.
Element | Type | Occurs | Description |
---|---|---|---|
![]() |
1..1 | ||
ns:return | xs:string | 0..1 | Build version information |
Name | Content | Description |
---|---|---|
ReleaseRequestServiceException | ns:ReleaseRequestServiceException |
Returns interface version for Release Requests web service
urn:getInterfaceVersion
Document
The output of this method is the document element ns:getInterfaceVersionResponse having the structure defined by the following table.
Element | Type | Occurs | Description |
---|---|---|---|
![]() |
1..1 | ||
ns:return | xs:string | 0..1 | Interface version information |
Name | Content | Description |
---|---|---|
ReleaseRequestServiceException | ns:ReleaseRequestServiceException |
urn:getRelatedBcrRequests
Document
The input of this method is the document element ns:getRelatedBcrRequests having the structure defined by the following table.
Element | Type | Occurs | Description |
---|---|---|---|
![]() |
1..1 | ||
ns:designMode | xs:boolean | 0..1 | |
ns:auth | ns:AuthInfo | 0..1 | |
ns:arId | xs:string | 0..1 | |
The output of this method is the document element ns:getRelatedBcrRequestsResponse having the structure defined by the following table.
Element | Type | Occurs | Description |
---|---|---|---|
![]() |
1..1 | ||
ns:return | ns:BcrRequestInfo | 0..* | |
Name | Content | Description |
---|---|---|
ReleaseRequestServiceException | ns:ReleaseRequestServiceException |
Returns related projects for a specified release package
urn:getRelatedRequestProjects
Document
The input of this method is the document element ns:getRelatedRequestProjects having the structure defined by the following table.
Element | Type | Occurs | Description |
---|---|---|---|
![]() |
1..1 | ||
ns:designMode | xs:boolean | 0..1 | Enable design mode if set to true. |
ns:auth | ns:AuthInfo | 0..1 | Authentication information |
ns:packageId | xs:string | 0..1 | Release package ID |
The output of this method is the document element ns:getRelatedRequestProjectsResponse having the structure defined by the following table.
Element | Type | Occurs | Description |
---|---|---|---|
![]() |
1..1 | ||
ns:return | ns:ProjectInfo | 0..* | |
Name | Content | Description |
---|---|---|
ReleaseRequestServiceException | ns:ReleaseRequestServiceException |
Returns related requests for specified release package
urn:getRelatedRequests
Document
The input of this method is the document element ns:getRelatedRequests having the structure defined by the following table.
Element | Type | Occurs | Description |
---|---|---|---|
![]() |
1..1 | ||
ns:designMode | xs:boolean | 0..1 | Enable design mode if set to true. |
ns:auth | ns:AuthInfo | 0..1 | Authentication information |
ns:packageId | xs:string | 0..1 | Release package ID |
The output of this method is the document element ns:getRelatedRequestsResponse having the structure defined by the following table.
Element | Type | Occurs | Description |
---|---|---|---|
![]() |
1..1 | ||
ns:return | ns:RequestInfo | 0..* | |
Name | Content | Description |
---|---|---|
ReleaseRequestServiceException | ns:ReleaseRequestServiceException |
urn:getRelatedRfcRequests
Document
The input of this method is the document element ns:getRelatedRfcRequests having the structure defined by the following table.
Element | Type | Occurs | Description |
---|---|---|---|
![]() |
1..1 | ||
ns:designMode | xs:boolean | 0..1 | |
ns:auth | ns:AuthInfo | 0..1 | |
ns:rtId | xs:string | 0..1 | |
The output of this method is the document element ns:getRelatedRfcRequestsResponse having the structure defined by the following table.
Element | Type | Occurs | Description |
---|---|---|---|
![]() |
1..1 | ||
ns:return | ns:RfcRequestInfo | 0..* | |
Name | Content | Description |
---|---|---|
ReleaseRequestServiceException | ns:ReleaseRequestServiceException |
Returns projects
urn:getRequestProjects
Document
The input of this method is the document element ns:getRequestProjects having the structure defined by the following table.
Element | Type | Occurs | Description |
---|---|---|---|
![]() |
1..1 | ||
ns:designMode | xs:boolean | 0..1 | Enable design mode if set to true. |
ns:auth | ns:AuthInfo | 0..1 | Authentication information |
The output of this method is the document element ns:getRequestProjectsResponse having the structure defined by the following table.
Element | Type | Occurs | Description |
---|---|---|---|
![]() |
1..1 | ||
ns:return | ns:ProjectInfo | 0..* | |
Name | Content | Description |
---|---|---|
ReleaseRequestServiceException | ns:ReleaseRequestServiceException |
Returns requests from registered request providers.
urn:getRequests
Document
The input of this method is the document element ns:getRequests having the structure defined by the following table.
Element | Type | Occurs | Description |
---|---|---|---|
![]() |
1..1 | ||
ns:designMode | xs:boolean | 0..1 | Enable design mode if set to true. |
ns:auth | ns:AuthInfo | 0..1 | Authentication information |
ns:packageId | xs:string | 0..1 | Release package ID |
The output of this method is the document element ns:getRequestsResponse having the structure defined by the following table.
Element | Type | Occurs | Description |
---|---|---|---|
![]() |
1..1 | ||
ns:return | ns:RequestInfo | 0..* | |
Name | Content | Description |
---|---|---|
ReleaseRequestServiceException | ns:ReleaseRequestServiceException |
urn:getRfcRequests
Document
The input of this method is the document element ns:getRfcRequests having the structure defined by the following table.
Element | Type | Occurs | Description |
---|---|---|---|
![]() |
1..1 | ||
ns:designMode | xs:boolean | 0..1 | |
ns:auth | ns:AuthInfo | 0..1 | |
ns:filter | xs:string | 0..1 | |
The output of this method is the document element ns:getRfcRequestsResponse having the structure defined by the following table.
Element | Type | Occurs | Description |
---|---|---|---|
![]() |
1..1 | ||
ns:return | ns:RfcRequestInfo | 0..* | |
Name | Content | Description |
---|---|---|
ReleaseRequestServiceException | ns:ReleaseRequestServiceException |
urn:relateBcrRequests
Document
The input of this method is the document element ns:relateBcrRequests having the structure defined by the following table.
Element | Type | Occurs | Description |
---|---|---|---|
![]() |
1..1 | ||
ns:designMode | xs:boolean | 0..1 | |
ns:auth | ns:AuthInfo | 0..1 | |
ns:arId | xs:string | 0..1 | |
ns:requestIds | xs:string | 0..1 | |
The output of this method is the document element ns:relateBcrRequestsResponse having the structure defined by the following table.
Element | Type | Occurs | Description |
---|---|---|---|
![]() |
1..1 | ||
ns:return | ns:BcrRequestInfo | 0..* | |
Name | Content | Description |
---|---|---|
ReleaseRequestServiceException | ns:ReleaseRequestServiceException |
Relates specified project to specified release package
urn:relateRequestProjects
Document
The input of this method is the document element ns:relateRequestProjects having the structure defined by the following table.
Element | Type | Occurs | Description |
---|---|---|---|
![]() |
1..1 | ||
ns:designMode | xs:boolean | 0..1 | Enable design mode if set to true. |
ns:auth | ns:AuthInfo | 0..1 | Authentication information |
ns:packageId | xs:string | 0..1 | Release package ID |
ns:projectIds | xs:string | 0..1 | Project ID list |
The output of this method is the document element ns:relateRequestProjectsResponse having the structure defined by the following table.
Element | Type | Occurs | Description |
---|---|---|---|
![]() |
1..1 | ||
ns:return | ns:ProjectInfo | 0..* | |
Name | Content | Description |
---|---|---|
ReleaseRequestServiceException | ns:ReleaseRequestServiceException |
Relates specified requests to specified release package
urn:relateRequests
Document
The input of this method is the document element ns:relateRequests having the structure defined by the following table.
Element | Type | Occurs | Description |
---|---|---|---|
![]() |
1..1 | ||
ns:designMode | xs:boolean | 0..1 | Enable design mode if set to true. |
ns:auth | ns:AuthInfo | 0..1 | Authentication information |
ns:packageId | xs:string | 0..1 | Release package ID |
ns:requestIds | xs:string | 0..1 | Request ID list |
The output of this method is the document element ns:relateRequestsResponse having the structure defined by the following table.
Element | Type | Occurs | Description |
---|---|---|---|
![]() |
1..1 | ||
ns:return | ns:RequestInfo | 0..* | |
Name | Content | Description |
---|---|---|
ReleaseRequestServiceException | ns:ReleaseRequestServiceException |
urn:relateRfcRequests
Document
The input of this method is the document element ns:relateRfcRequests having the structure defined by the following table.
Element | Type | Occurs | Description |
---|---|---|---|
![]() |
1..1 | ||
ns:designMode | xs:boolean | 0..1 | |
ns:auth | ns:AuthInfo | 0..1 | |
ns:rtId | xs:string | 0..1 | |
ns:requestIds | xs:string | 0..1 | |
The output of this method is the document element ns:relateRfcRequestsResponse having the structure defined by the following table.
Element | Type | Occurs | Description |
---|---|---|---|
![]() |
1..1 | ||
ns:return | ns:RfcRequestInfo | 0..* | |
Name | Content | Description |
---|---|---|
ReleaseRequestServiceException | ns:ReleaseRequestServiceException |
urn:unRelateBcrRequests
Document
The input of this method is the document element ns:unRelateBcrRequests having the structure defined by the following table.
Element | Type | Occurs | Description |
---|---|---|---|
![]() |
1..1 | ||
ns:designMode | xs:boolean | 0..1 | |
ns:auth | ns:AuthInfo | 0..1 | |
ns:arId | xs:string | 0..1 | |
ns:requestIds | xs:string | 0..1 | |
The output of this method is the document element ns:unRelateBcrRequestsResponse having the structure defined by the following table.
Element | Type | Occurs | Description |
---|---|---|---|
![]() |
1..1 | ||
ns:return | ns:BcrRequestInfo | 0..* | |
Name | Content | Description |
---|---|---|
ReleaseRequestServiceException | ns:ReleaseRequestServiceException |
Un-relates specified project from specified release package
urn:unRelateRequestProjects
Document
The input of this method is the document element ns:unRelateRequestProjects having the structure defined by the following table.
Element | Type | Occurs | Description |
---|---|---|---|
![]() |
1..1 | ||
ns:designMode | xs:boolean | 0..1 | Enable design mode if set to true. |
ns:auth | ns:AuthInfo | 0..1 | Authentication information |
ns:packageId | xs:string | 0..1 | Release package ID |
ns:projectIds | xs:string | 0..1 | Release package ID associated with this project |
The output of this method is the document element ns:unRelateRequestProjectsResponse having the structure defined by the following table.
Element | Type | Occurs | Description |
---|---|---|---|
![]() |
1..1 | ||
ns:return | ns:ProjectInfo | 0..* | |
Name | Content | Description |
---|---|---|
ReleaseRequestServiceException | ns:ReleaseRequestServiceException |
Un-relates specified request from specified release package
urn:unRelateRequests
Document
The input of this method is the document element ns:unRelateRequests having the structure defined by the following table.
Element | Type | Occurs | Description |
---|---|---|---|
![]() |
1..1 | ||
ns:designMode | xs:boolean | 0..1 | Enable design mode if set to true. |
ns:auth | ns:AuthInfo | 0..1 | Authentication information |
ns:packageId | xs:string | 0..1 | Release package ID |
ns:requestIds | xs:string | 0..1 | Request ID list |
The output of this method is the document element ns:unRelateRequestsResponse having the structure defined by the following table.
Element | Type | Occurs | Description |
---|---|---|---|
![]() |
1..1 | ||
ns:return | ns:RequestInfo | 0..* | |
Name | Content | Description |
---|---|---|
ReleaseRequestServiceException | ns:ReleaseRequestServiceException |
urn:unRelateRfcRequests
Document
The input of this method is the document element ns:unRelateRfcRequests having the structure defined by the following table.
Element | Type | Occurs | Description |
---|---|---|---|
![]() |
1..1 | ||
ns:designMode | xs:boolean | 0..1 | |
ns:unrelate | xs:boolean | 0..1 | |
ns:auth | ns:AuthInfo | 0..1 | |
ns:rtId | xs:string | 0..1 | |
ns:requestIds | xs:string | 0..1 | |
The output of this method is the document element ns:unRelateRfcRequestsResponse having the structure defined by the following table.
Element | Type | Occurs | Description |
---|---|---|---|
![]() |
1..1 | ||
ns:return | ns:RfcRequestInfo | 0..* | |
Name | Content | Description |
---|---|---|
ReleaseRequestServiceException | ns:ReleaseRequestServiceException |
Update request for a specified dev task
urn:updateDevTaskRequest
Document
The input of this method is the document element ns:updateDevTaskRequest having the structure defined by the following table.
Element | Type | Occurs | Description |
---|---|---|---|
![]() |
1..1 | ||
ns:designMode | xs:boolean | 0..1 | Enable design mode if set to true. |
ns:auth | ns:AuthInfo | 0..1 | Authentication information |
ns:id | xs:string | 1..1 | Dev task or CM request ID |
ns:updateOption | ns:updateTaskOption | 0..1 | Update option: 0 = Update CM only, 1 = Update SBM only, 2 = Update both CM and SBM |
ns:providerName | xs:string | 0..1 | Name of provider |
The output of this method is the document element ns:updateDevTaskRequestResponse having the structure defined by the following table.
Element | Type | Occurs | Description |
---|---|---|---|
![]() |
1..1 | ||
ns:return | ns:RequestInfo | 0..* | |
Name | Content | Description |
---|---|---|
ReleaseRequestServiceException | ns:ReleaseRequestServiceException |
Name | Description |
---|---|
ns:AuthInfo | |
ns:BcrRequestInfo | |
ns:ProjectInfo | |
ns:RequestInfo | |
ns:RfcRequestInfo |
Restricting xs:anyType
Contains elements as defined in the following table.
Component | Type | Occurs | Description |
---|---|---|---|
![]() |
1..1 | ||
ns:password | xs:string | 0..1 | Password |
ns:username | xs:string | 0..1 | User name |
Element ns:auth [element getBcrRequests]
Element ns:auth [element getRequests]
Element ns:auth [element getRfcRequests]
Element ns:auth [element relateRequests]
Restricting xs:anyType
Contains elements as defined in the following table.
Component | Type | Occurs | Description |
---|---|---|---|
![]() |
1..1 | ||
ns:description | xs:string | 0..1 | |
ns:displayName | xs:string | 0..1 | |
ns:id | xs:string | 0..1 | |
ns:providerName | xs:string | 0..1 | |
ns:relatedApplicationReleaseId | xs:string | 0..1 | |
ns:relatedReleaseTrainId | xs:string | 0..1 | |
ns:state | xs:string | 0..1 | |
ns:title | xs:string | 0..1 | |
Restricting xs:anyType
Contains elements as defined in the following table.
Component | Type | Occurs | Description |
---|---|---|---|
![]() |
1..1 | ||
ns:id | xs:string | 0..1 | Project ID |
ns:name | xs:string | 0..1 | Project name |
ns:owner | xs:string | 0..1 | Project owner |
ns:status | xs:string | 0..1 | Project status |
ns:type | xs:string | 0..1 | Project type |
ns:relatedPackageId | xs:string | 0..1 | Release package ID associated with this project |
ns:providerName | xs:string | 0..1 | Provider name |
Restricting xs:anyType
Contains elements as defined in the following table.
Component | Type | Occurs | Description |
---|---|---|---|
![]() |
1..1 | ||
ns:id | xs:string | 0..1 | Request ID |
ns:name | xs:string | 0..1 | Request name |
ns:status | xs:string | 0..1 | Request status |
ns:statusOld | xs:string | 0..1 | |
ns:url | xs:string | 0..1 | Request URL |
ns:owner | xs:string | 0..1 | Request owner |
ns:projectName | xs:string | 0..1 | Project name |
ns:relatedPackageId | xs:string | 0..1 | Release package ID associated with this request |
ns:relatedDevTaskId | xs:string | 0..1 | Dev task ID associated with this request |
ns:product | xs:string | 0..1 | Product associated with this request |
ns:role | xs:string | 0..1 | Role assigned to this request |
ns:developer | xs:string | 0..1 | Developer assigned to this request |
ns:targetDueDate | xs:string | 0..1 | Target due date assigned to this request |
ns:estimatedDevEffort | xs:string | 0..1 | Estimated development effort calculuated for this request |
ns:actualDevEffort | xs:string | 0..1 | Actual development effort spent on this request |
ns:providerName | xs:string | 0..1 | Provider name |
Restricting xs:anyType
Contains elements as defined in the following table.
Component | Type | Occurs | Description |
---|---|---|---|
![]() |
1..1 | ||
ns:description | xs:string | 0..1 | |
ns:displayName | xs:string | 0..1 | |
ns:id | xs:string | 0..1 | |
ns:providerName | xs:string | 0..1 | |
ns:relatedReleaseTrainId | xs:string | 0..1 | |
ns:state | xs:string | 0..1 | |
ns:title | xs:string | 0..1 | |
ns:related | xs:boolean | 0..1 | |
Name | Description |
---|---|
ns:updateTaskOption | Update task option. 0 - update CM 1 - update SBM. |
Update task option.
0 - update CM
1 - update SBM.
Restricting xs:string
Length of value must be less than or equal to 1.
Value | Description |
---|---|
0 | |
1 |
Actual development effort spent on this request
Type xs:string
Complex Type ns:RequestInfo
Authentication information
Type ns:AuthInfo
Contains elements as defined in the following table.
Component | Type | Occurs | Description |
---|---|---|---|
![]() |
1..1 | ||
ns:password | xs:string | 0..1 | Password |
ns:username | xs:string | 0..1 | User name |
Element ns:createDevTaskRequest
Authentication information
Type ns:AuthInfo
Contains elements as defined in the following table.
Component | Type | Occurs | Description |
---|---|---|---|
![]() |
1..1 | ||
ns:password | xs:string | 0..1 | Password |
ns:username | xs:string | 0..1 | User name |
Element ns:delegateDevTaskRequest
Type ns:AuthInfo
Contains elements as defined in the following table.
Component | Type | Occurs | Description |
---|---|---|---|
![]() |
1..1 | ||
ns:password | xs:string | 0..1 | Password |
ns:username | xs:string | 0..1 | User name |
Element ns:executeSSMTransition
Type ns:AuthInfo
Contains elements as defined in the following table.
Component | Type | Occurs | Description |
---|---|---|---|
![]() |
1..1 | ||
ns:password | xs:string | 0..1 | Password |
ns:username | xs:string | 0..1 | User name |
Element ns:getBcrRequests
Type ns:AuthInfo
Contains elements as defined in the following table.
Component | Type | Occurs | Description |
---|---|---|---|
![]() |
1..1 | ||
ns:password | xs:string | 0..1 | Password |
ns:username | xs:string | 0..1 | User name |
Element ns:getRelatedBcrRequests
Authentication information
Type ns:AuthInfo
Contains elements as defined in the following table.
Component | Type | Occurs | Description |
---|---|---|---|
![]() |
1..1 | ||
ns:password | xs:string | 0..1 | Password |
ns:username | xs:string | 0..1 | User name |
Element ns:getRelatedRequestProjects
Authentication information
Type ns:AuthInfo
Contains elements as defined in the following table.
Component | Type | Occurs | Description |
---|---|---|---|
![]() |
1..1 | ||
ns:password | xs:string | 0..1 | Password |
ns:username | xs:string | 0..1 | User name |
Element ns:getRelatedRequests
Type ns:AuthInfo
Contains elements as defined in the following table.
Component | Type | Occurs | Description |
---|---|---|---|
![]() |
1..1 | ||
ns:password | xs:string | 0..1 | Password |
ns:username | xs:string | 0..1 | User name |
Element ns:getRelatedRfcRequests
Authentication information
Type ns:AuthInfo
Contains elements as defined in the following table.
Component | Type | Occurs | Description |
---|---|---|---|
![]() |
1..1 | ||
ns:password | xs:string | 0..1 | Password |
ns:username | xs:string | 0..1 | User name |
Element ns:getRequestProjects
Authentication information
Type ns:AuthInfo
Contains elements as defined in the following table.
Component | Type | Occurs | Description |
---|---|---|---|
![]() |
1..1 | ||
ns:password | xs:string | 0..1 | Password |
ns:username | xs:string | 0..1 | User name |
Element ns:getRequests
Type ns:AuthInfo
Contains elements as defined in the following table.
Component | Type | Occurs | Description |
---|---|---|---|
![]() |
1..1 | ||
ns:password | xs:string | 0..1 | Password |
ns:username | xs:string | 0..1 | User name |
Element ns:getRfcRequests
Type ns:AuthInfo
Contains elements as defined in the following table.
Component | Type | Occurs | Description |
---|---|---|---|
![]() |
1..1 | ||
ns:password | xs:string | 0..1 | Password |
ns:username | xs:string | 0..1 | User name |
Element ns:relateBcrRequests
Authentication information
Type ns:AuthInfo
Contains elements as defined in the following table.
Component | Type | Occurs | Description |
---|---|---|---|
![]() |
1..1 | ||
ns:password | xs:string | 0..1 | Password |
ns:username | xs:string | 0..1 | User name |
Element ns:relateRequestProjects
Authentication information
Type ns:AuthInfo
Contains elements as defined in the following table.
Component | Type | Occurs | Description |
---|---|---|---|
![]() |
1..1 | ||
ns:password | xs:string | 0..1 | Password |
ns:username | xs:string | 0..1 | User name |
Element ns:relateRequests
Type ns:AuthInfo
Contains elements as defined in the following table.
Component | Type | Occurs | Description |
---|---|---|---|
![]() |
1..1 | ||
ns:password | xs:string | 0..1 | Password |
ns:username | xs:string | 0..1 | User name |
Element ns:relateRfcRequests
Type ns:AuthInfo
Contains elements as defined in the following table.
Component | Type | Occurs | Description |
---|---|---|---|
![]() |
1..1 | ||
ns:password | xs:string | 0..1 | Password |
ns:username | xs:string | 0..1 | User name |
Element ns:unRelateBcrRequests
Authentication information
Type ns:AuthInfo
Contains elements as defined in the following table.
Component | Type | Occurs | Description |
---|---|---|---|
![]() |
1..1 | ||
ns:password | xs:string | 0..1 | Password |
ns:username | xs:string | 0..1 | User name |
Element ns:unRelateRequestProjects
Authentication information
Type ns:AuthInfo
Contains elements as defined in the following table.
Component | Type | Occurs | Description |
---|---|---|---|
![]() |
1..1 | ||
ns:password | xs:string | 0..1 | Password |
ns:username | xs:string | 0..1 | User name |
Element ns:unRelateRequests
Type ns:AuthInfo
Contains elements as defined in the following table.
Component | Type | Occurs | Description |
---|---|---|---|
![]() |
1..1 | ||
ns:password | xs:string | 0..1 | Password |
ns:username | xs:string | 0..1 | User name |
Element ns:unRelateRfcRequests
Authentication information
Type ns:AuthInfo
Contains elements as defined in the following table.
Component | Type | Occurs | Description |
---|---|---|---|
![]() |
1..1 | ||
ns:password | xs:string | 0..1 | Password |
ns:username | xs:string | 0..1 | User name |
Element ns:updateDevTaskRequest
Restricting xs:anyType
Contains elements as defined in the following table.
Component | Type | Occurs | Description |
---|---|---|---|
![]() |
1..1 | ||
ns:designMode | xs:boolean | 0..1 | Enable design mode if set to true. |
ns:auth | ns:AuthInfo | 0..1 | Authentication information |
ns:devTaskId | xs:string | 1..1 | Dev task ID |
ns:providerName | xs:string | 0..1 | Name of provider |
Restricting xs:anyType
Contains elements as defined in the following table.
Component | Type | Occurs | Description |
---|---|---|---|
![]() |
1..1 | ||
ns:return | ns:RequestInfo | 0..* | |
Restricting xs:anyType
Contains elements as defined in the following table.
Component | Type | Occurs | Description |
---|---|---|---|
![]() |
1..1 | ||
ns:designMode | xs:boolean | 0..1 | Enable design mode if set to true. |
ns:auth | ns:AuthInfo | 0..1 | Authentication information |
ns:devTaskId | xs:string | 1..1 | Dev task ID |
ns:providerName | xs:string | 0..1 | Name of provider |
Restricting xs:anyType
Contains elements as defined in the following table.
Component | Type | Occurs | Description |
---|---|---|---|
![]() |
1..1 | ||
ns:return | ns:RequestInfo | 0..* | |
Enable design mode if set to true.
Type xs:boolean
Element ns:createDevTaskRequest
Enable design mode if set to true.
Type xs:boolean
Element ns:delegateDevTaskRequest
Enable design mode if set to true.
Type xs:boolean
Element ns:getRelatedRequestProjects
Enable design mode if set to true.
Type xs:boolean
Element ns:getRelatedRequests
Enable design mode if set to true.
Type xs:boolean
Element ns:getRequestProjects
Enable design mode if set to true.
Type xs:boolean
Element ns:getRequests
Enable design mode if set to true.
Type xs:boolean
Element ns:relateRequestProjects
Enable design mode if set to true.
Type xs:boolean
Element ns:relateRequests
Enable design mode if set to true.
Type xs:boolean
Element ns:unRelateRequestProjects
Enable design mode if set to true.
Type xs:boolean
Element ns:unRelateRequests
Enable design mode if set to true.
Type xs:boolean
Element ns:updateDevTaskRequest
Developer assigned to this request
Type xs:string
Complex Type ns:RequestInfo
Estimated development effort calculuated for this request
Type xs:string
Complex Type ns:RequestInfo
Restricting xs:anyType
Contains elements as defined in the following table.
Component | Type | Occurs | Description |
---|---|---|---|
![]() |
1..1 | ||
ns:auth | ns:AuthInfo | 0..1 | |
ns:rtId | xs:string | 0..1 | |
ns:transition | xs:string | 0..1 | |
ns:requestIds | xs:string | 0..1 | |
Restricting xs:anyType
Contains elements as defined in the following table.
Component | Type | Occurs | Description |
---|---|---|---|
![]() |
1..1 | ||
ns:return | ns:RfcRequestInfo | 0..* | |
Restricting xs:anyType
Contains elements as defined in the following table.
Component | Type | Occurs | Description |
---|---|---|---|
![]() |
1..1 | ||
ns:designMode | xs:boolean | 0..1 | |
ns:auth | ns:AuthInfo | 0..1 | |
ns:filter | xs:string | 0..1 | |
Restricting xs:anyType
Contains elements as defined in the following table.
Component | Type | Occurs | Description |
---|---|---|---|
![]() |
1..1 | ||
ns:return | ns:BcrRequestInfo | 0..* | |
Restricting xs:anyType
Contains elements as defined in the following table.
Component | Type | Occurs | Description |
---|---|---|---|
![]() |
1..1 | ||
ns:return | xs:string | 0..1 | Build version information |
Restricting xs:anyType
Contains elements as defined in the following table.
Component | Type | Occurs | Description |
---|---|---|---|
![]() |
1..1 | ||
ns:return | xs:string | 0..1 | Interface version information |
Restricting xs:anyType
Contains elements as defined in the following table.
Component | Type | Occurs | Description |
---|---|---|---|
![]() |
1..1 | ||
ns:designMode | xs:boolean | 0..1 | |
ns:auth | ns:AuthInfo | 0..1 | |
ns:arId | xs:string | 0..1 | |
Restricting xs:anyType
Contains elements as defined in the following table.
Component | Type | Occurs | Description |
---|---|---|---|
![]() |
1..1 | ||
ns:return | ns:BcrRequestInfo | 0..* | |
Restricting xs:anyType
Contains elements as defined in the following table.
Component | Type | Occurs | Description |
---|---|---|---|
![]() |
1..1 | ||
ns:designMode | xs:boolean | 0..1 | Enable design mode if set to true. |
ns:auth | ns:AuthInfo | 0..1 | Authentication information |
ns:packageId | xs:string | 0..1 | Release package ID |
Restricting xs:anyType
Contains elements as defined in the following table.
Component | Type | Occurs | Description |
---|---|---|---|
![]() |
1..1 | ||
ns:return | ns:ProjectInfo | 0..* | |
Restricting xs:anyType
Contains elements as defined in the following table.
Component | Type | Occurs | Description |
---|---|---|---|
![]() |
1..1 | ||
ns:designMode | xs:boolean | 0..1 | Enable design mode if set to true. |
ns:auth | ns:AuthInfo | 0..1 | Authentication information |
ns:packageId | xs:string | 0..1 | Release package ID |
Restricting xs:anyType
Contains elements as defined in the following table.
Component | Type | Occurs | Description |
---|---|---|---|
![]() |
1..1 | ||
ns:return | ns:RequestInfo | 0..* | |
Restricting xs:anyType
Contains elements as defined in the following table.
Component | Type | Occurs | Description |
---|---|---|---|
![]() |
1..1 | ||
ns:designMode | xs:boolean | 0..1 | |
ns:auth | ns:AuthInfo | 0..1 | |
ns:rtId | xs:string | 0..1 | |
Restricting xs:anyType
Contains elements as defined in the following table.
Component | Type | Occurs | Description |
---|---|---|---|
![]() |
1..1 | ||
ns:return | ns:RfcRequestInfo | 0..* | |
Restricting xs:anyType
Contains elements as defined in the following table.
Component | Type | Occurs | Description |
---|---|---|---|
![]() |
1..1 | ||
ns:designMode | xs:boolean | 0..1 | Enable design mode if set to true. |
ns:auth | ns:AuthInfo | 0..1 | Authentication information |
Restricting xs:anyType
Contains elements as defined in the following table.
Component | Type | Occurs | Description |
---|---|---|---|
![]() |
1..1 | ||
ns:return | ns:ProjectInfo | 0..* | |
Restricting xs:anyType
Contains elements as defined in the following table.
Component | Type | Occurs | Description |
---|---|---|---|
![]() |
1..1 | ||
ns:designMode | xs:boolean | 0..1 | Enable design mode if set to true. |
ns:auth | ns:AuthInfo | 0..1 | Authentication information |
ns:packageId | xs:string | 0..1 | Release package ID |
Restricting xs:anyType
Contains elements as defined in the following table.
Component | Type | Occurs | Description |
---|---|---|---|
![]() |
1..1 | ||
ns:return | ns:RequestInfo | 0..* | |
Restricting xs:anyType
Contains elements as defined in the following table.
Component | Type | Occurs | Description |
---|---|---|---|
![]() |
1..1 | ||
ns:designMode | xs:boolean | 0..1 | |
ns:auth | ns:AuthInfo | 0..1 | |
ns:filter | xs:string | 0..1 | |
Restricting xs:anyType
Contains elements as defined in the following table.
Component | Type | Occurs | Description |
---|---|---|---|
![]() |
1..1 | ||
ns:return | ns:RfcRequestInfo | 0..* | |
Dev task or CM request ID
Type xs:string
Element ns:updateDevTaskRequest
Release package ID
Type xs:string
Element ns:getRelatedRequestProjects
Release package ID
Type xs:string
Element ns:getRelatedRequests
Release package ID
Type xs:string
Element ns:relateRequestProjects
Release package ID
Type xs:string
Element ns:unRelateRequestProjects
Product associated with this request
Type xs:string
Complex Type ns:RequestInfo
Project ID list
Type xs:string
Element ns:relateRequestProjects
Release package ID associated with this project
Type xs:string
Element ns:unRelateRequestProjects
Name of provider
Type xs:string
Element ns:createDevTaskRequest
Name of provider
Type xs:string
Element ns:delegateDevTaskRequest
Name of provider
Type xs:string
Element ns:updateDevTaskRequest
Restricting xs:anyType
Contains elements as defined in the following table.
Component | Type | Occurs | Description |
---|---|---|---|
![]() |
1..1 | ||
ns:designMode | xs:boolean | 0..1 | |
ns:auth | ns:AuthInfo | 0..1 | |
ns:arId | xs:string | 0..1 | |
ns:requestIds | xs:string | 0..1 | |
Restricting xs:anyType
Contains elements as defined in the following table.
Component | Type | Occurs | Description |
---|---|---|---|
![]() |
1..1 | ||
ns:return | ns:BcrRequestInfo | 0..* | |
Dev task ID associated with this request
Type xs:string
Complex Type ns:RequestInfo
Release package ID associated with this project
Type xs:string
Complex Type ns:ProjectInfo
Release package ID associated with this request
Type xs:string
Complex Type ns:RequestInfo
Restricting xs:anyType
Contains elements as defined in the following table.
Component | Type | Occurs | Description |
---|---|---|---|
![]() |
1..1 | ||
ns:designMode | xs:boolean | 0..1 | Enable design mode if set to true. |
ns:auth | ns:AuthInfo | 0..1 | Authentication information |
ns:packageId | xs:string | 0..1 | Release package ID |
ns:projectIds | xs:string | 0..1 | Project ID list |
Restricting xs:anyType
Contains elements as defined in the following table.
Component | Type | Occurs | Description |
---|---|---|---|
![]() |
1..1 | ||
ns:return | ns:ProjectInfo | 0..* | |
Restricting xs:anyType
Contains elements as defined in the following table.
Component | Type | Occurs | Description |
---|---|---|---|
![]() |
1..1 | ||
ns:designMode | xs:boolean | 0..1 | Enable design mode if set to true. |
ns:auth | ns:AuthInfo | 0..1 | Authentication information |
ns:packageId | xs:string | 0..1 | Release package ID |
ns:requestIds | xs:string | 0..1 | Request ID list |
Restricting xs:anyType
Contains elements as defined in the following table.
Component | Type | Occurs | Description |
---|---|---|---|
![]() |
1..1 | ||
ns:return | ns:RequestInfo | 0..* | |
Restricting xs:anyType
Contains elements as defined in the following table.
Component | Type | Occurs | Description |
---|---|---|---|
![]() |
1..1 | ||
ns:designMode | xs:boolean | 0..1 | |
ns:auth | ns:AuthInfo | 0..1 | |
ns:rtId | xs:string | 0..1 | |
ns:requestIds | xs:string | 0..1 | |
Restricting xs:anyType
Contains elements as defined in the following table.
Component | Type | Occurs | Description |
---|---|---|---|
![]() |
1..1 | ||
ns:return | ns:RfcRequestInfo | 0..* | |
error message
Type xs:string
Restricting xs:anyType
Contains elements as defined in the following table.
Component | Type | Occurs | Description |
---|---|---|---|
![]() |
1..1 | ||
ns:ReleaseRequestServiceException | xs:string | 0..1 | error message |
Type ns:RequestInfo
Contains elements as defined in the following table.
Component | Type | Occurs | Description |
---|---|---|---|
![]() |
1..1 | ||
ns:id | xs:string | 0..1 | Request ID |
ns:name | xs:string | 0..1 | Request name |
ns:status | xs:string | 0..1 | Request status |
ns:statusOld | xs:string | 0..1 | |
ns:url | xs:string | 0..1 | Request URL |
ns:owner | xs:string | 0..1 | Request owner |
ns:projectName | xs:string | 0..1 | Project name |
ns:relatedPackageId | xs:string | 0..1 | Release package ID associated with this request |
ns:relatedDevTaskId | xs:string | 0..1 | Dev task ID associated with this request |
ns:product | xs:string | 0..1 | Product associated with this request |
ns:role | xs:string | 0..1 | Role assigned to this request |
ns:developer | xs:string | 0..1 | Developer assigned to this request |
ns:targetDueDate | xs:string | 0..1 | Target due date assigned to this request |
ns:estimatedDevEffort | xs:string | 0..1 | Estimated development effort calculuated for this request |
ns:actualDevEffort | xs:string | 0..1 | Actual development effort spent on this request |
ns:providerName | xs:string | 0..1 | Provider name |
Element ns:createDevTaskRequestResponse
Type ns:RequestInfo
Contains elements as defined in the following table.
Component | Type | Occurs | Description |
---|---|---|---|
![]() |
1..1 | ||
ns:id | xs:string | 0..1 | Request ID |
ns:name | xs:string | 0..1 | Request name |
ns:status | xs:string | 0..1 | Request status |
ns:statusOld | xs:string | 0..1 | |
ns:url | xs:string | 0..1 | Request URL |
ns:owner | xs:string | 0..1 | Request owner |
ns:projectName | xs:string | 0..1 | Project name |
ns:relatedPackageId | xs:string | 0..1 | Release package ID associated with this request |
ns:relatedDevTaskId | xs:string | 0..1 | Dev task ID associated with this request |
ns:product | xs:string | 0..1 | Product associated with this request |
ns:role | xs:string | 0..1 | Role assigned to this request |
ns:developer | xs:string | 0..1 | Developer assigned to this request |
ns:targetDueDate | xs:string | 0..1 | Target due date assigned to this request |
ns:estimatedDevEffort | xs:string | 0..1 | Estimated development effort calculuated for this request |
ns:actualDevEffort | xs:string | 0..1 | Actual development effort spent on this request |
ns:providerName | xs:string | 0..1 | Provider name |
Type ns:RfcRequestInfo
Contains elements as defined in the following table.
Component | Type | Occurs | Description |
---|---|---|---|
![]() |
1..1 | ||
ns:description | xs:string | 0..1 | |
ns:displayName | xs:string | 0..1 | |
ns:id | xs:string | 0..1 | |
ns:providerName | xs:string | 0..1 | |
ns:relatedReleaseTrainId | xs:string | 0..1 | |
ns:state | xs:string | 0..1 | |
ns:title | xs:string | 0..1 | |
ns:related | xs:boolean | 0..1 | |
Element ns:executeSSMTransitionResponse
Type ns:BcrRequestInfo
Contains elements as defined in the following table.
Component | Type | Occurs | Description |
---|---|---|---|
![]() |
1..1 | ||
ns:description | xs:string | 0..1 | |
ns:displayName | xs:string | 0..1 | |
ns:id | xs:string | 0..1 | |
ns:providerName | xs:string | 0..1 | |
ns:relatedApplicationReleaseId | xs:string | 0..1 | |
ns:relatedReleaseTrainId | xs:string | 0..1 | |
ns:state | xs:string | 0..1 | |
ns:title | xs:string | 0..1 | |
Element ns:getBcrRequestsResponse
Build version information
Type xs:string
Element ns:getBuildVersionResponse
Interface version information
Type xs:string
Element ns:getInterfaceVersionResponse
Type ns:BcrRequestInfo
Contains elements as defined in the following table.
Component | Type | Occurs | Description |
---|---|---|---|
![]() |
1..1 | ||
ns:description | xs:string | 0..1 | |
ns:displayName | xs:string | 0..1 | |
ns:id | xs:string | 0..1 | |
ns:providerName | xs:string | 0..1 | |
ns:relatedApplicationReleaseId | xs:string | 0..1 | |
ns:relatedReleaseTrainId | xs:string | 0..1 | |
ns:state | xs:string | 0..1 | |
ns:title | xs:string | 0..1 | |
Element ns:getRelatedBcrRequestsResponse
Type ns:ProjectInfo
Contains elements as defined in the following table.
Component | Type | Occurs | Description |
---|---|---|---|
![]() |
1..1 | ||
ns:id | xs:string | 0..1 | Project ID |
ns:name | xs:string | 0..1 | Project name |
ns:owner | xs:string | 0..1 | Project owner |
ns:status | xs:string | 0..1 | Project status |
ns:type | xs:string | 0..1 | Project type |
ns:relatedPackageId | xs:string | 0..1 | Release package ID associated with this project |
ns:providerName | xs:string | 0..1 | Provider name |
Type ns:RequestInfo
Contains elements as defined in the following table.
Component | Type | Occurs | Description |
---|---|---|---|
![]() |
1..1 | ||
ns:id | xs:string | 0..1 | Request ID |
ns:name | xs:string | 0..1 | Request name |
ns:status | xs:string | 0..1 | Request status |
ns:statusOld | xs:string | 0..1 | |
ns:url | xs:string | 0..1 | Request URL |
ns:owner | xs:string | 0..1 | Request owner |
ns:projectName | xs:string | 0..1 | Project name |
ns:relatedPackageId | xs:string | 0..1 | Release package ID associated with this request |
ns:relatedDevTaskId | xs:string | 0..1 | Dev task ID associated with this request |
ns:product | xs:string | 0..1 | Product associated with this request |
ns:role | xs:string | 0..1 | Role assigned to this request |
ns:developer | xs:string | 0..1 | Developer assigned to this request |
ns:targetDueDate | xs:string | 0..1 | Target due date assigned to this request |
ns:estimatedDevEffort | xs:string | 0..1 | Estimated development effort calculuated for this request |
ns:actualDevEffort | xs:string | 0..1 | Actual development effort spent on this request |
ns:providerName | xs:string | 0..1 | Provider name |
Element ns:getRelatedRequestsResponse
Type ns:RfcRequestInfo
Contains elements as defined in the following table.
Component | Type | Occurs | Description |
---|---|---|---|
![]() |
1..1 | ||
ns:description | xs:string | 0..1 | |
ns:displayName | xs:string | 0..1 | |
ns:id | xs:string | 0..1 | |
ns:providerName | xs:string | 0..1 | |
ns:relatedReleaseTrainId | xs:string | 0..1 | |
ns:state | xs:string | 0..1 | |
ns:title | xs:string | 0..1 | |
ns:related | xs:boolean | 0..1 | |
Element ns:getRelatedRfcRequestsResponse
Type ns:ProjectInfo
Contains elements as defined in the following table.
Component | Type | Occurs | Description |
---|---|---|---|
![]() |
1..1 | ||
ns:id | xs:string | 0..1 | Project ID |
ns:name | xs:string | 0..1 | Project name |
ns:owner | xs:string | 0..1 | Project owner |
ns:status | xs:string | 0..1 | Project status |
ns:type | xs:string | 0..1 | Project type |
ns:relatedPackageId | xs:string | 0..1 | Release package ID associated with this project |
ns:providerName | xs:string | 0..1 | Provider name |
Element ns:getRequestProjectsResponse
Type ns:RequestInfo
Contains elements as defined in the following table.
Component | Type | Occurs | Description |
---|---|---|---|
![]() |
1..1 | ||
ns:id | xs:string | 0..1 | Request ID |
ns:name | xs:string | 0..1 | Request name |
ns:status | xs:string | 0..1 | Request status |
ns:statusOld | xs:string | 0..1 | |
ns:url | xs:string | 0..1 | Request URL |
ns:owner | xs:string | 0..1 | Request owner |
ns:projectName | xs:string | 0..1 | Project name |
ns:relatedPackageId | xs:string | 0..1 | Release package ID associated with this request |
ns:relatedDevTaskId | xs:string | 0..1 | Dev task ID associated with this request |
ns:product | xs:string | 0..1 | Product associated with this request |
ns:role | xs:string | 0..1 | Role assigned to this request |
ns:developer | xs:string | 0..1 | Developer assigned to this request |
ns:targetDueDate | xs:string | 0..1 | Target due date assigned to this request |
ns:estimatedDevEffort | xs:string | 0..1 | Estimated development effort calculuated for this request |
ns:actualDevEffort | xs:string | 0..1 | Actual development effort spent on this request |
ns:providerName | xs:string | 0..1 | Provider name |
Element ns:getRequestsResponse
Type ns:RfcRequestInfo
Contains elements as defined in the following table.
Component | Type | Occurs | Description |
---|---|---|---|
![]() |
1..1 | ||
ns:description | xs:string | 0..1 | |
ns:displayName | xs:string | 0..1 | |
ns:id | xs:string | 0..1 | |
ns:providerName | xs:string | 0..1 | |
ns:relatedReleaseTrainId | xs:string | 0..1 | |
ns:state | xs:string | 0..1 | |
ns:title | xs:string | 0..1 | |
ns:related | xs:boolean | 0..1 | |
Element ns:getRfcRequestsResponse
Type ns:BcrRequestInfo
Contains elements as defined in the following table.
Component | Type | Occurs | Description |
---|---|---|---|
![]() |
1..1 | ||
ns:description | xs:string | 0..1 | |
ns:displayName | xs:string | 0..1 | |
ns:id | xs:string | 0..1 | |
ns:providerName | xs:string | 0..1 | |
ns:relatedApplicationReleaseId | xs:string | 0..1 | |
ns:relatedReleaseTrainId | xs:string | 0..1 | |
ns:state | xs:string | 0..1 | |
ns:title | xs:string | 0..1 | |
Element ns:relateBcrRequestsResponse
Type ns:ProjectInfo
Contains elements as defined in the following table.
Component | Type | Occurs | Description |
---|---|---|---|
![]() |
1..1 | ||
ns:id | xs:string | 0..1 | Project ID |
ns:name | xs:string | 0..1 | Project name |
ns:owner | xs:string | 0..1 | Project owner |
ns:status | xs:string | 0..1 | Project status |
ns:type | xs:string | 0..1 | Project type |
ns:relatedPackageId | xs:string | 0..1 | Release package ID associated with this project |
ns:providerName | xs:string | 0..1 | Provider name |
Element ns:relateRequestProjectsResponse
Type ns:RequestInfo
Contains elements as defined in the following table.
Component | Type | Occurs | Description |
---|---|---|---|
![]() |
1..1 | ||
ns:id | xs:string | 0..1 | Request ID |
ns:name | xs:string | 0..1 | Request name |
ns:status | xs:string | 0..1 | Request status |
ns:statusOld | xs:string | 0..1 | |
ns:url | xs:string | 0..1 | Request URL |
ns:owner | xs:string | 0..1 | Request owner |
ns:projectName | xs:string | 0..1 | Project name |
ns:relatedPackageId | xs:string | 0..1 | Release package ID associated with this request |
ns:relatedDevTaskId | xs:string | 0..1 | Dev task ID associated with this request |
ns:product | xs:string | 0..1 | Product associated with this request |
ns:role | xs:string | 0..1 | Role assigned to this request |
ns:developer | xs:string | 0..1 | Developer assigned to this request |
ns:targetDueDate | xs:string | 0..1 | Target due date assigned to this request |
ns:estimatedDevEffort | xs:string | 0..1 | Estimated development effort calculuated for this request |
ns:actualDevEffort | xs:string | 0..1 | Actual development effort spent on this request |
ns:providerName | xs:string | 0..1 | Provider name |
Element ns:relateRequestsResponse
Type ns:RfcRequestInfo
Contains elements as defined in the following table.
Component | Type | Occurs | Description |
---|---|---|---|
![]() |
1..1 | ||
ns:description | xs:string | 0..1 | |
ns:displayName | xs:string | 0..1 | |
ns:id | xs:string | 0..1 | |
ns:providerName | xs:string | 0..1 | |
ns:relatedReleaseTrainId | xs:string | 0..1 | |
ns:state | xs:string | 0..1 | |
ns:title | xs:string | 0..1 | |
ns:related | xs:boolean | 0..1 | |
Element ns:relateRfcRequestsResponse
Type ns:BcrRequestInfo
Contains elements as defined in the following table.
Component | Type | Occurs | Description |
---|---|---|---|
![]() |
1..1 | ||
ns:description | xs:string | 0..1 | |
ns:displayName | xs:string | 0..1 | |
ns:id | xs:string | 0..1 | |
ns:providerName | xs:string | 0..1 | |
ns:relatedApplicationReleaseId | xs:string | 0..1 | |
ns:relatedReleaseTrainId | xs:string | 0..1 | |
ns:state | xs:string | 0..1 | |
ns:title | xs:string | 0..1 | |
Element ns:unRelateBcrRequestsResponse
Type ns:ProjectInfo
Contains elements as defined in the following table.
Component | Type | Occurs | Description |
---|---|---|---|
![]() |
1..1 | ||
ns:id | xs:string | 0..1 | Project ID |
ns:name | xs:string | 0..1 | Project name |
ns:owner | xs:string | 0..1 | Project owner |
ns:status | xs:string | 0..1 | Project status |
ns:type | xs:string | 0..1 | Project type |
ns:relatedPackageId | xs:string | 0..1 | Release package ID associated with this project |
ns:providerName | xs:string | 0..1 | Provider name |
Type ns:RequestInfo
Contains elements as defined in the following table.
Component | Type | Occurs | Description |
---|---|---|---|
![]() |
1..1 | ||
ns:id | xs:string | 0..1 | Request ID |
ns:name | xs:string | 0..1 | Request name |
ns:status | xs:string | 0..1 | Request status |
ns:statusOld | xs:string | 0..1 | |
ns:url | xs:string | 0..1 | Request URL |
ns:owner | xs:string | 0..1 | Request owner |
ns:projectName | xs:string | 0..1 | Project name |
ns:relatedPackageId | xs:string | 0..1 | Release package ID associated with this request |
ns:relatedDevTaskId | xs:string | 0..1 | Dev task ID associated with this request |
ns:product | xs:string | 0..1 | Product associated with this request |
ns:role | xs:string | 0..1 | Role assigned to this request |
ns:developer | xs:string | 0..1 | Developer assigned to this request |
ns:targetDueDate | xs:string | 0..1 | Target due date assigned to this request |
ns:estimatedDevEffort | xs:string | 0..1 | Estimated development effort calculuated for this request |
ns:actualDevEffort | xs:string | 0..1 | Actual development effort spent on this request |
ns:providerName | xs:string | 0..1 | Provider name |
Element ns:unRelateRequestsResponse
Type ns:RfcRequestInfo
Contains elements as defined in the following table.
Component | Type | Occurs | Description |
---|---|---|---|
![]() |
1..1 | ||
ns:description | xs:string | 0..1 | |
ns:displayName | xs:string | 0..1 | |
ns:id | xs:string | 0..1 | |
ns:providerName | xs:string | 0..1 | |
ns:relatedReleaseTrainId | xs:string | 0..1 | |
ns:state | xs:string | 0..1 | |
ns:title | xs:string | 0..1 | |
ns:related | xs:boolean | 0..1 | |
Element ns:unRelateRfcRequestsResponse
Type ns:RequestInfo
Contains elements as defined in the following table.
Component | Type | Occurs | Description |
---|---|---|---|
![]() |
1..1 | ||
ns:id | xs:string | 0..1 | Request ID |
ns:name | xs:string | 0..1 | Request name |
ns:status | xs:string | 0..1 | Request status |
ns:statusOld | xs:string | 0..1 | |
ns:url | xs:string | 0..1 | Request URL |
ns:owner | xs:string | 0..1 | Request owner |
ns:projectName | xs:string | 0..1 | Project name |
ns:relatedPackageId | xs:string | 0..1 | Release package ID associated with this request |
ns:relatedDevTaskId | xs:string | 0..1 | Dev task ID associated with this request |
ns:product | xs:string | 0..1 | Product associated with this request |
ns:role | xs:string | 0..1 | Role assigned to this request |
ns:developer | xs:string | 0..1 | Developer assigned to this request |
ns:targetDueDate | xs:string | 0..1 | Target due date assigned to this request |
ns:estimatedDevEffort | xs:string | 0..1 | Estimated development effort calculuated for this request |
ns:actualDevEffort | xs:string | 0..1 | Actual development effort spent on this request |
ns:providerName | xs:string | 0..1 | Provider name |
Element ns:updateDevTaskRequestResponse
Role assigned to this request
Type xs:string
Complex Type ns:RequestInfo
Target due date assigned to this request
Type xs:string
Complex Type ns:RequestInfo
Restricting xs:anyType
Contains elements as defined in the following table.
Component | Type | Occurs | Description |
---|---|---|---|
![]() |
1..1 | ||
ns:designMode | xs:boolean | 0..1 | |
ns:auth | ns:AuthInfo | 0..1 | |
ns:arId | xs:string | 0..1 | |
ns:requestIds | xs:string | 0..1 | |
Restricting xs:anyType
Contains elements as defined in the following table.
Component | Type | Occurs | Description |
---|---|---|---|
![]() |
1..1 | ||
ns:return | ns:BcrRequestInfo | 0..* | |
Restricting xs:anyType
Contains elements as defined in the following table.
Component | Type | Occurs | Description |
---|---|---|---|
![]() |
1..1 | ||
ns:designMode | xs:boolean | 0..1 | Enable design mode if set to true. |
ns:auth | ns:AuthInfo | 0..1 | Authentication information |
ns:packageId | xs:string | 0..1 | Release package ID |
ns:projectIds | xs:string | 0..1 | Release package ID associated with this project |
Restricting xs:anyType
Contains elements as defined in the following table.
Component | Type | Occurs | Description |
---|---|---|---|
![]() |
1..1 | ||
ns:return | ns:ProjectInfo | 0..* | |
Restricting xs:anyType
Contains elements as defined in the following table.
Component | Type | Occurs | Description |
---|---|---|---|
![]() |
1..1 | ||
ns:designMode | xs:boolean | 0..1 | Enable design mode if set to true. |
ns:auth | ns:AuthInfo | 0..1 | Authentication information |
ns:packageId | xs:string | 0..1 | Release package ID |
ns:requestIds | xs:string | 0..1 | Request ID list |
Restricting xs:anyType
Contains elements as defined in the following table.
Component | Type | Occurs | Description |
---|---|---|---|
![]() |
1..1 | ||
ns:return | ns:RequestInfo | 0..* | |
Restricting xs:anyType
Contains elements as defined in the following table.
Component | Type | Occurs | Description |
---|---|---|---|
![]() |
1..1 | ||
ns:designMode | xs:boolean | 0..1 | |
ns:unrelate | xs:boolean | 0..1 | |
ns:auth | ns:AuthInfo | 0..1 | |
ns:rtId | xs:string | 0..1 | |
ns:requestIds | xs:string | 0..1 | |
Restricting xs:anyType
Contains elements as defined in the following table.
Component | Type | Occurs | Description |
---|---|---|---|
![]() |
1..1 | ||
ns:return | ns:RfcRequestInfo | 0..* | |
Restricting xs:anyType
Contains elements as defined in the following table.
Component | Type | Occurs | Description |
---|---|---|---|
![]() |
1..1 | ||
ns:designMode | xs:boolean | 0..1 | Enable design mode if set to true. |
ns:auth | ns:AuthInfo | 0..1 | Authentication information |
ns:id | xs:string | 1..1 | Dev task or CM request ID |
ns:updateOption | ns:updateTaskOption | 0..1 | Update option: 0 = Update CM only, 1 = Update SBM only, 2 = Update both CM and SBM |
ns:providerName | xs:string | 0..1 | Name of provider |
Restricting xs:anyType
Contains elements as defined in the following table.
Component | Type | Occurs | Description |
---|---|---|---|
![]() |
1..1 | ||
ns:return | ns:RequestInfo | 0..* | |
Update option: 0 = Update CM only, 1 = Update SBM only, 2 = Update both CM and SBM
Type ns:updateTaskOption
Length of value must be less than or equal to 1.
Value | Description |
---|---|
0 | |
1 |
Element ns:updateDevTaskRequest
Serena Release Manager Vault Service
SOAP 1.2
Document
Previously called Deployment Unit Service
Name | Description |
---|---|
buildDevPackageBaseline | Build vault baseline for a specified development package |
createDevPackageBaseline | Create a vault baseline for a specified development package |
createVaultObject | Create a vault baseline |
deliverToVault | Create a vault baseline |
failDevPackageBaseline | Fail a vault baseline for a specified development package |
getApprovers | Returns list of available ZMF application approvers |
getBaselineTemplates | Returns list of available vault baseline templates |
getBaselineTypes | Returns list of available vault baseline types |
getBuildAreas | Returns list of available vault build areas |
getBuildConfigurations | Returns list of available vault build configurations |
getBuildVersion | Returns build version for Vault web service |
getDeploymentArea | Returns list of deployment areas |
getDeploymentSites | Returns list of available ZMF deployment sites |
getDeploymentStages | Returns list of available deployment stages |
getDesignParts | Returns list of available vault design parts |
getGslAreas | Returns list of all areas defined for a specific stage of the Dimensions GSL |
getGslStages | Returns list of stages in the Dimensions CM Global Stage Lifecycle |
getInterfaceVersion | Returns interface version number |
getNetNodes | Returns list of all network nodes of Dimensions CM |
getProducts | Returns list of available vault products |
getProjects | Returns list of available vault projects |
getPromotionAreas | Returns list of available ZMF deployment promotion areas |
getRelatedVaultBaselineProjects | Returns list of related deployment unit projects |
getRelatedVaultBaselines | Returns list of related vault baselines |
getVaultBaselineProjects | Returns vault baselines projects |
getVaultBaselines | Returns list of available vault baselines separated by commas |
relateVaultBaselineProjects | Relates deployment unit projects to specified release package |
relateVaultBaselines | Relate specified vault baselines to specified release package |
releaseDevPackageBaseline | Create a vault baseline for a specified development package |
setDMLBaselineFlag | Set DML baseline flag |
unrelateVaultBaselineProjects | Un-relate deployment unit projects |
unrelateVaultBaselines |
Build vault baseline for a specified development package
urn:buildDevPackageBaseline
Document
The input of this method is the document element ns:buildDevPackageBaseline having the structure defined by the following table.
Element | Type | Occurs | Description |
---|---|---|---|
![]() |
1..1 | ||
ns:auth | ns:AuthInfo | 0..1 | Authentication information |
ns:devPackageId | xs:string | 0..1 | Item identifier of development package item id. |
ns:providerName | xs:string | 0..1 | Name of provider |
The output of this method is the document element ns:buildDevPackageBaselineResponse having the structure defined by the following table.
Element | Type | Occurs | Description |
---|---|---|---|
![]() |
1..1 | ||
ns:return | ns:VaultBaselineInfo | 0..1 | |
Name | Content | Description |
---|---|---|
VaultServiceException | ns:VaultServiceException |
Create a vault baseline for a specified development package
urn:createDevPackageBaseline
Document
The input of this method is the document element ns:createDevPackageBaseline having the structure defined by the following table.
Element | Type | Occurs | Description |
---|---|---|---|
![]() |
1..1 | ||
ns:auth | ns:AuthInfo | 0..1 | Authentication information |
ns:devPackageId | xs:string | 0..1 | Item identifier of development package item id. |
ns:providerName | xs:string | 0..1 | Name of provider |
ns:requestIds | xs:string | 0..1 | |
ns:removeRequestIds | xs:string | 0..1 | |
ns:autoRevised | xs:boolean | 0..1 | |
The output of this method is the document element ns:createDevPackageBaselineResponse having the structure defined by the following table.
Element | Type | Occurs | Description |
---|---|---|---|
![]() |
1..1 | ||
ns:return | ns:VaultBaselineInfo | 0..1 | |
Name | Content | Description |
---|---|---|
VaultServiceException | ns:VaultServiceException |
Create a vault baseline
urn:createVaultObject
Document
The input of this method is the document element ns:createVaultObject having the structure defined by the following table.
Element | Type | Occurs | Description |
---|---|---|---|
![]() |
1..1 | ||
ns:auth | ns:AuthInfo | 0..1 | Authentication information |
ns:vaultRemoteNodePath | xs:string | 0..1 | |
ns:projectName | xs:string | 0..1 | |
ns:dimItemSpec | xs:string | 0..1 | |
ns:projectSpec | xs:string | 0..1 | |
ns:fileName | xs:string | 0..1 | |
ns:baselineSpec | xs:string | 0..1 | |
ns:sourceRemoteNodePath | xs:string | 0..1 | |
ns:configAsXML | xs:string | 0..1 | |
ns:stage | xs:string | 0..1 | |
ns:description | xs:string | 0..1 | |
ns:dml | xs:boolean | 0..1 | |
ns:dryRun | xs:boolean | 0..1 | |
ns:returnLogInfo | xs:boolean | 0..1 | |
ns:cleanup | xs:boolean | 0..1 | |
The output of this method is the document element ns:createVaultObjectResponse having the structure defined by the following table.
Element | Type | Occurs | Description |
---|---|---|---|
![]() |
1..1 | ||
ns:result | xs:boolean | 0..1 | |
Name | Content | Description |
---|---|---|
VaultServiceException | ns:VaultServiceException |
Create a vault baseline
urn:deliverToVault
Document
The input of this method is the document element ns:deliverToVault having the structure defined by the following table.
Element | Type | Occurs | Description |
---|---|---|---|
![]() |
1..1 | ||
ns:auth | ns:AuthInfo | 0..1 | Authentication information |
ns:baselineSpec | xs:string | 0..1 | |
ns:id | xs:string | 0..1 | |
ns:type | xs:string | 0..1 | |
The output of this method is the document element ns:deliverToVaultResponse having the structure defined by the following table.
Element | Type | Occurs | Description |
---|---|---|---|
![]() |
1..1 | ||
ns:result | xs:boolean | 0..1 | |
Name | Content | Description |
---|---|---|
VaultServiceException | ns:VaultServiceException |
Fail a vault baseline for a specified development package
urn:failDevPackageBaseline
Document
The input of this method is the document element ns:failDevPackageBaseline having the structure defined by the following table.
Element | Type | Occurs | Description |
---|---|---|---|
![]() |
1..1 | ||
ns:auth | ns:AuthInfo | 0..1 | Authentication information |
ns:devPackageId | xs:string | 0..1 | Item identifier of development package item id. |
ns:providerName | xs:string | 0..1 | Name of provider |
The output of this method is the document element ns:failDevPackageBaselineResponse having the structure defined by the following table.
Element | Type | Occurs | Description |
---|---|---|---|
![]() |
1..1 | ||
ns:result | xs:boolean | 0..1 | |
Name | Content | Description |
---|---|---|
VaultServiceException | ns:VaultServiceException |
Returns list of available ZMF application approvers
urn:getApprovers
Document
The input of this method is the document element ns:getApprovers having the structure defined by the following table.
Element | Type | Occurs | Description |
---|---|---|---|
![]() |
1..1 | ||
ns:designMode | xs:boolean | 0..1 | Run service in design mode. Returns dummy data for use in SBM composer. |
ns:auth | ns:AuthInfo | 0..1 | Authentication information |
ns:projectName | xs:string | 1..1 | Name of project |
ns:providerName | xs:string | 0..1 | Name of provider |
The output of this method is the document element ns:getApproversResponse having the structure defined by the following table.
Element | Type | Occurs | Description |
---|---|---|---|
![]() |
1..1 | ||
ns:return | ns:ApproverInfo | 0..* | |
Name | Content | Description |
---|---|---|
VaultServiceException | ns:VaultServiceException |
Returns list of available vault baseline templates
urn:getBaselineTemplates
Document
The input of this method is the document element ns:getBaselineTemplates having the structure defined by the following table.
Element | Type | Occurs | Description |
---|---|---|---|
![]() |
1..1 | ||
ns:designMode | xs:boolean | 0..1 | Run service in design mode. Returns dummy data for use in SBM composer. |
ns:auth | ns:AuthInfo | 0..1 | Authentication information |
ns:product | xs:string | 0..1 | Name of product |
ns:providerName | xs:string | 0..1 | Name of provider |
The output of this method is the document element ns:getBaselineTemplatesResponse having the structure defined by the following table.
Element | Type | Occurs | Description |
---|---|---|---|
![]() |
1..1 | ||
ns:return | ns:BaselineTemplateInfo | 0..* | |
Name | Content | Description |
---|---|---|
VaultServiceException | ns:VaultServiceException |
Returns list of available vault baseline types
urn:getBaselineTypes
Document
The input of this method is the document element ns:getBaselineTypes having the structure defined by the following table.
Element | Type | Occurs | Description |
---|---|---|---|
![]() |
1..1 | ||
ns:designMode | xs:boolean | 0..1 | Run service in design mode. Returns dummy data for use in SBM composer. |
ns:auth | ns:AuthInfo | 0..1 | Authentication information |
ns:product | xs:string | 0..1 | Name of product |
ns:providerName | xs:string | 0..1 | Name of provider |
The output of this method is the document element ns:getBaselineTypesResponse having the structure defined by the following table.
Element | Type | Occurs | Description |
---|---|---|---|
![]() |
1..1 | ||
ns:return | ns:BaselineTypeInfo | 0..* | |
Name | Content | Description |
---|---|---|
VaultServiceException | ns:VaultServiceException |
Returns list of available vault build areas
urn:getBuildAreas
Document
The input of this method is the document element ns:getBuildAreas having the structure defined by the following table.
Element | Type | Occurs | Description |
---|---|---|---|
![]() |
1..1 | ||
ns:designMode | xs:boolean | 0..1 | Run service in design mode. Returns dummy data for use in SBM composer. |
ns:auth | ns:AuthInfo | 0..1 | Authentication information |
ns:product | xs:string | 0..1 | Name of product |
ns:project | xs:string | 0..1 | Name of project |
ns:buildConfiguration | xs:string | 0..1 | Name of build configuration |
ns:providerName | xs:string | 0..1 | Name of provider |
The output of this method is the document element ns:getBuildAreasResponse having the structure defined by the following table.
Element | Type | Occurs | Description |
---|---|---|---|
![]() |
1..1 | ||
ns:return | ns:BuildAreaInfo | 0..* | |
Name | Content | Description |
---|---|---|
VaultServiceException | ns:VaultServiceException |
Returns list of available vault build configurations
urn:getBuildConfigurations
Document
The input of this method is the document element ns:getBuildConfigurations having the structure defined by the following table.
Element | Type | Occurs | Description |
---|---|---|---|
![]() |
1..1 | ||
ns:designMode | xs:boolean | 0..1 | Run service in design mode. Returns dummy data for use in SBM composer. |
ns:auth | ns:AuthInfo | 0..1 | Authentication information |
ns:product | xs:string | 0..1 | Name of product |
ns:project | xs:string | 0..1 | Name of project |
ns:providerName | xs:string | 0..1 | Name of provider |
The output of this method is the document element ns:getBuildConfigurationsResponse having the structure defined by the following table.
Element | Type | Occurs | Description |
---|---|---|---|
![]() |
1..1 | ||
ns:return | ns:BuildConfigInfo | 0..* | |
Name | Content | Description |
---|---|---|
VaultServiceException | ns:VaultServiceException |
Returns build version for Vault web service
urn:getBuildVersion
Document
The output of this method is the document element ns:getBuildVersionResponse having the structure defined by the following table.
Element | Type | Occurs | Description |
---|---|---|---|
![]() |
1..1 | ||
ns:return | xs:string | 0..1 | |
Name | Content | Description |
---|---|---|
VaultServiceException | ns:VaultServiceException |
Returns list of deployment areas
urn:getDeploymentArea
Document
The input of this method is the document element ns:getDeploymentArea having the structure defined by the following table.
Element | Type | Occurs | Description |
---|---|---|---|
![]() |
1..1 | ||
ns:designMode | xs:boolean | 0..1 | Run service in design mode. Returns dummy data for use in SBM composer. |
ns:auth | ns:AuthInfo | 0..1 | Authentication information |
ns:stageName | xs:string | 0..1 | Name of deployment stage |
ns:projectName | xs:string | 0..1 | Name of project |
ns:packageId | xs:string | 0..1 | Identifier of release package |
ns:vaultBaselineIds | xs:string | 0..1 | Identifiers of vault baselines separated by commas |
The output of this method is the document element ns:getDeploymentAreaResponse having the structure defined by the following table.
Element | Type | Occurs | Description |
---|---|---|---|
![]() |
1..1 | ||
ns:return | ns:DeployAreaInfo | 0..* | |
Name | Content | Description |
---|---|---|
VaultServiceException | ns:VaultServiceException |
Returns list of available ZMF deployment sites
urn:getDeploymentSites
Document
The input of this method is the document element ns:getDeploymentSites having the structure defined by the following table.
Element | Type | Occurs | Description |
---|---|---|---|
![]() |
1..1 | ||
ns:designMode | xs:boolean | 0..1 | Run service in design mode. Returns dummy data for use in SBM composer. |
ns:auth | ns:AuthInfo | 0..1 | Authentication information |
ns:projectName | xs:string | 1..1 | Name of project |
ns:providerName | xs:string | 0..1 | Name of provider |
The output of this method is the document element ns:getDeploymentSitesResponse having the structure defined by the following table.
Element | Type | Occurs | Description |
---|---|---|---|
![]() |
1..1 | ||
ns:return | ns:DeploySiteInfo | 0..* | |
Name | Content | Description |
---|---|---|
VaultServiceException | ns:VaultServiceException |
Returns list of available deployment stages
urn:getDeploymentStages
Document
The input of this method is the document element ns:getDeploymentStages having the structure defined by the following table.
Element | Type | Occurs | Description |
---|---|---|---|
![]() |
1..1 | ||
ns:designMode | xs:boolean | 0..1 | Run service in design mode. Returns dummy data for use in SBM composer. |
ns:auth | ns:AuthInfo | 0..1 | Authentication information |
ns:projectName | xs:string | 0..1 | Name of project used for filtering available stages |
ns:packageId | xs:string | 0..1 | Item identifier of release package (in form of table_id:record_id, for example 1001:11) - used for filtering available stages |
ns:vaultBaselineIds | xs:string | 0..1 | Identifiers of vault baselines separated by commas - used for filtering available stages |
The output of this method is the document element ns:getDeploymentStagesResponse having the structure defined by the following table.
Element | Type | Occurs | Description |
---|---|---|---|
![]() |
1..1 | ||
ns:return | ns:DeployStageInfo | 0..* | |
Name | Content | Description |
---|---|---|
VaultServiceException | ns:VaultServiceException |
Returns list of available vault design parts
urn:getDesignParts
Document
The input of this method is the document element ns:getDesignParts having the structure defined by the following table.
Element | Type | Occurs | Description |
---|---|---|---|
![]() |
1..1 | ||
ns:designMode | xs:boolean | 0..1 | Run service in design mode. Returns dummy data for use in SBM composer. |
ns:auth | ns:AuthInfo | 0..1 | Authentication information |
ns:product | xs:string | 0..1 | Name of product |
ns:providerName | xs:string | 0..1 | Name of provider |
The output of this method is the document element ns:getDesignPartsResponse having the structure defined by the following table.
Element | Type | Occurs | Description |
---|---|---|---|
![]() |
1..1 | ||
ns:return | ns:DesignPartsInfo | 0..* | |
Name | Content | Description |
---|---|---|
VaultServiceException | ns:VaultServiceException |
Returns list of all areas defined for a specific stage of the Dimensions GSL
urn:getGslAreas
Document
The input of this method is the document element ns:getGslAreas having the structure defined by the following table.
Element | Type | Occurs | Description |
---|---|---|---|
![]() |
1..1 | ||
ns:designMode | xs:boolean | 0..1 | Run service in design mode. Returns dummy data for use in SBM composer. |
ns:auth | ns:AuthInfo | 0..1 | Authentication information |
ns:stageName | xs:string | 0..1 | Name of deployment stage |
The output of this method is the document element ns:getGslAreasResponse having the structure defined by the following table.
Element | Type | Occurs | Description |
---|---|---|---|
![]() |
1..1 | ||
ns:return | ns:DeployAreaInfo | 0..* | |
Name | Content | Description |
---|---|---|
VaultServiceException | ns:VaultServiceException |
Returns list of stages in the Dimensions CM Global Stage Lifecycle
urn:getGslStages
Document
The input of this method is the document element ns:getGslStages having the structure defined by the following table.
Element | Type | Occurs | Description |
---|---|---|---|
![]() |
1..1 | ||
ns:designMode | xs:boolean | 0..1 | Run service in design mode. Returns dummy data for use in SBM composer. |
ns:auth | ns:AuthInfo | 0..1 | Authentication information |
The output of this method is the document element ns:getGslStagesResponse having the structure defined by the following table.
Element | Type | Occurs | Description |
---|---|---|---|
![]() |
1..1 | ||
ns:return | ns:DeployStageInfo | 0..* | |
Name | Content | Description |
---|---|---|
VaultServiceException | ns:VaultServiceException |
Returns interface version number
urn:getInterfaceVersion
Document
The output of this method is the document element ns:getInterfaceVersionResponse having the structure defined by the following table.
Element | Type | Occurs | Description |
---|---|---|---|
![]() |
1..1 | ||
ns:return | xs:string | 0..1 | Interface version number |
Name | Content | Description |
---|---|---|
VaultServiceException | ns:VaultServiceException |
Returns list of all network nodes of Dimensions CM
urn:getNetNodes
Document
The input of this method is the document element ns:getNetNodes having the structure defined by the following table.
Element | Type | Occurs | Description |
---|---|---|---|
![]() |
1..1 | ||
ns:designMode | xs:boolean | 0..1 | Run service in design mode. Returns dummy data for use in SBM composer. |
ns:auth | ns:AuthInfo | 0..1 | Authentication information |
The output of this method is the document element ns:getNetNodesResponse having the structure defined by the following table.
Element | Type | Occurs | Description |
---|---|---|---|
![]() |
1..1 | ||
ns:return | ns:NetNodeInfo | 0..* | |
Name | Content | Description |
---|---|---|
VaultServiceException | ns:VaultServiceException |
Returns list of available vault products
urn:getProducts
Document
The input of this method is the document element ns:getProducts having the structure defined by the following table.
Element | Type | Occurs | Description |
---|---|---|---|
![]() |
1..1 | ||
ns:designMode | xs:boolean | 0..1 | Run service in design mode. Returns dummy data for use in SBM composer. |
ns:auth | ns:AuthInfo | 0..1 | Authentication information |
ns:providerName | xs:string | 0..1 | Name of provider |
The output of this method is the document element ns:getProductsResponse having the structure defined by the following table.
Element | Type | Occurs | Description |
---|---|---|---|
![]() |
1..1 | ||
ns:return | ns:ProductInfo | 0..* | |
Name | Content | Description |
---|---|---|
VaultServiceException | ns:VaultServiceException |
Returns list of available vault projects
urn:getProjects
Document
The input of this method is the document element ns:getProjects having the structure defined by the following table.
Element | Type | Occurs | Description |
---|---|---|---|
![]() |
1..1 | ||
ns:designMode | xs:boolean | 0..1 | Run service in design mode. Returns dummy data for use in SBM composer. |
ns:auth | ns:AuthInfo | 0..1 | Authentication information |
ns:product | xs:string | 0..1 | Name of product |
ns:providerName | xs:string | 0..1 | Name of provider |
The output of this method is the document element ns:getProjectsResponse having the structure defined by the following table.
Element | Type | Occurs | Description |
---|---|---|---|
![]() |
1..1 | ||
ns:return | ns:ProjectInfo | 0..* | |
Name | Content | Description |
---|---|---|
VaultServiceException | ns:VaultServiceException |
Returns list of available ZMF deployment promotion areas
urn:getPromotionAreas
Document
The input of this method is the document element ns:getPromotionAreas having the structure defined by the following table.
Element | Type | Occurs | Description |
---|---|---|---|
![]() |
1..1 | ||
ns:designMode | xs:boolean | 0..1 | Run service in design mode. Returns dummy data for use in SBM composer. |
ns:auth | ns:AuthInfo | 0..1 | Authentication information |
ns:projectName | xs:string | 1..1 | Name of project |
ns:deploymentSite | xs:string | 1..1 | Name of deployment site |
ns:providerName | xs:string | 0..1 | Name of provider |
The output of this method is the document element ns:getPromotionAreasResponse having the structure defined by the following table.
Element | Type | Occurs | Description |
---|---|---|---|
![]() |
1..1 | ||
ns:return | ns:PromotionAreaInfo | 0..* | |
Name | Content | Description |
---|---|---|
VaultServiceException | ns:VaultServiceException |
Returns list of related deployment unit projects
urn:getRelatedVaultBaselineProjects
Document
The input of this method is the document element ns:getRelatedVaultBaselineProjects having the structure defined by the following table.
Element | Type | Occurs | Description |
---|---|---|---|
![]() |
1..1 | ||
ns:designMode | xs:boolean | 0..1 | Run service in design mode. Returns dummy data for use in SBM composer. |
ns:auth | ns:AuthInfo | 0..1 | Authentication information |
ns:packageId | xs:string | 0..1 | Item identifier of release package (in form of table_id:record_id, for example 1001:11) |
The output of this method is the document element ns:getRelatedVaultBaselineProjectsResponse having the structure defined by the following table.
Element | Type | Occurs | Description |
---|---|---|---|
![]() |
1..1 | ||
ns:return | ns:ProjectInfo | 0..* | |
Name | Content | Description |
---|---|---|
VaultServiceException | ns:VaultServiceException |
Returns list of related vault baselines
urn:getRelatedVaultBaselines
Document
The input of this method is the document element ns:getRelatedVaultBaselines having the structure defined by the following table.
Element | Type | Occurs | Description |
---|---|---|---|
![]() |
1..1 | ||
ns:designMode | xs:boolean | 0..1 | Run service in design mode. Returns dummy data for use in SBM composer. |
ns:auth | ns:AuthInfo | 0..1 | Authentication information |
ns:packageId | xs:string | 0..1 | Item identifier of release package (in form of table_id:record_id, for example 1001:11) |
ns:providerName | xs:string | 0..1 | Name of provider |
The output of this method is the document element ns:getRelatedVaultBaselinesResponse having the structure defined by the following table.
Element | Type | Occurs | Description |
---|---|---|---|
![]() |
1..1 | ||
ns:return | ns:VaultBaselineInfo | 0..* | |
Name | Content | Description |
---|---|---|
VaultServiceException | ns:VaultServiceException |
Returns vault baselines projects
urn:getVaultBaselineProjects
Document
The input of this method is the document element ns:getVaultBaselineProjects having the structure defined by the following table.
Element | Type | Occurs | Description |
---|---|---|---|
![]() |
1..1 | ||
ns:designMode | xs:boolean | 0..1 | Run service in design mode. Returns dummy data for use in SBM composer. |
ns:auth | ns:AuthInfo | 0..1 | Authentication information |
ns:providerName | xs:string | 0..1 | Name of provider |
The output of this method is the document element ns:getVaultBaselineProjectsResponse having the structure defined by the following table.
Element | Type | Occurs | Description |
---|---|---|---|
![]() |
1..1 | ||
ns:return | ns:ProjectInfo | 0..* | |
Name | Content | Description |
---|---|---|
VaultServiceException | ns:VaultServiceException |
Returns list of available vault baselines separated by commas
urn:getVaultBaselines
Document
The input of this method is the document element ns:getVaultBaselines having the structure defined by the following table.
Element | Type | Occurs | Description |
---|---|---|---|
![]() |
1..1 | ||
ns:designMode | xs:boolean | 0..1 | Run service in design mode. Returns dummy data for use in SBM composer. |
ns:auth | ns:AuthInfo | 0..1 | Authentication information |
ns:providerName | xs:string | 0..1 | Name of provider |
ns:packageId | xs:string | 0..1 | Item identifier of release package (in form of table_id:record_id, for example 1001:11) |
ns:projectId | xs:string | 0..1 | Project identifier |
The output of this method is the document element ns:getVaultBaselinesResponse having the structure defined by the following table.
Element | Type | Occurs | Description |
---|---|---|---|
![]() |
1..1 | ||
ns:return | ns:VaultBaselineInfo | 0..* | |
Name | Content | Description |
---|---|---|
VaultServiceException | ns:VaultServiceException |
Relates deployment unit projects to specified release package
urn:relateVaultBaselineProjects
Document
The input of this method is the document element ns:relateVaultBaselineProjects having the structure defined by the following table.
Element | Type | Occurs | Description |
---|---|---|---|
![]() |
1..1 | ||
ns:designMode | xs:boolean | 0..1 | Run service in design mode. Returns dummy data for use in SBM composer. |
ns:auth | ns:AuthInfo | 0..1 | Authentication information |
ns:packageId | xs:string | 0..1 | Item identifier of release package (in form of table_id:record_id, for example 1001:11) |
ns:projectIds | xs:string | 0..1 | Identifiers of deployment unit projects separated by commas |
ns:providerName | xs:string | 0..1 | Name of provider |
The output of this method is the document element ns:relateVaultBaselineProjectsResponse having the structure defined by the following table.
Element | Type | Occurs | Description |
---|---|---|---|
![]() |
1..1 | ||
ns:return | ns:ProjectInfo | 0..* | |
Name | Content | Description |
---|---|---|
VaultServiceException | ns:VaultServiceException |
Relate specified vault baselines to specified release package
urn:relateVaultBaselines
Document
The input of this method is the document element ns:relateVaultBaselines having the structure defined by the following table.
Element | Type | Occurs | Description |
---|---|---|---|
![]() |
1..1 | ||
ns:designMode | xs:boolean | 0..1 | Run service in design mode. Returns dummy data for use in SBM composer. |
ns:auth | ns:AuthInfo | 0..1 | Authentication information |
ns:packageId | xs:string | 0..1 | Item identifier of release package (in form of table_id:record_id, for example 1001:11) |
ns:vaultBaselineIds | xs:string | 0..1 | Identifiers of vault baselines separated by commas |
ns:providerName | xs:string | 0..1 | Name of provider |
The output of this method is the document element ns:relateVaultBaselinesResponse having the structure defined by the following table.
Element | Type | Occurs | Description |
---|---|---|---|
![]() |
1..1 | ||
ns:return | ns:VaultBaselineInfo | 0..* | |
Name | Content | Description |
---|---|---|
VaultServiceException | ns:VaultServiceException |
Create a vault baseline for a specified development package
urn:releaseDevPackageBaseline
Document
The input of this method is the document element ns:releaseDevPackageBaseline having the structure defined by the following table.
Element | Type | Occurs | Description |
---|---|---|---|
![]() |
1..1 | ||
ns:auth | ns:AuthInfo | 0..1 | Authentication information |
ns:devPackageId | xs:string | 0..1 | Item identifier of development package item id. |
ns:providerName | xs:string | 0..1 | Name of provider |
The output of this method is the document element ns:releaseDevPackageBaselineResponse having the structure defined by the following table.
Element | Type | Occurs | Description |
---|---|---|---|
![]() |
1..1 | ||
ns:result | xs:boolean | 0..1 | |
Name | Content | Description |
---|---|---|
VaultServiceException | ns:VaultServiceException |
Set DML baseline flag
urn:setDMLBaselineFlag
Document
The input of this method is the document element ns:setDMLBaselineFlag having the structure defined by the following table.
Element | Type | Occurs | Description |
---|---|---|---|
![]() |
1..1 | ||
ns:auth | ns:AuthInfo | 0..1 | Authentication information |
ns:baselineSpec | xs:string | 0..1 | |
ns:flag | xs:boolean | 0..1 | |
The output of this method is the document element ns:setDMLBaselineFlagResponse having the structure defined by the following table.
Element | Type | Occurs | Description |
---|---|---|---|
![]() |
1..1 | ||
ns:result | xs:boolean | 0..1 | |
Name | Content | Description |
---|---|---|
VaultServiceException | ns:VaultServiceException |
Un-relate deployment unit projects
urn:unrelateVaultBaselineProjects
Document
The input of this method is the document element ns:unrelateVaultBaselineProjects having the structure defined by the following table.
Element | Type | Occurs | Description |
---|---|---|---|
![]() |
1..1 | ||
ns:designMode | xs:boolean | 0..1 | Run service in design mode. Returns dummy data for use in SBM Composer. |
ns:auth | ns:AuthInfo | 0..1 | Authentication information |
ns:packageId | xs:string | 0..1 | Item identifier of release package (in form of table_id:record_id, for example 1001:11) |
ns:projectIds | xs:string | 0..1 | Identifiers of projects that should be unrelated from specified package |
The output of this method is the document element ns:unrelateVaultBaselineProjectsResponse having the structure defined by the following table.
Element | Type | Occurs | Description |
---|---|---|---|
![]() |
1..1 | ||
ns:return | ns:ProjectInfo | 0..* | |
Name | Content | Description |
---|---|---|
VaultServiceException | ns:VaultServiceException |
urn:unrelateVaultBaselines
Document
The input of this method is the document element ns:unrelateVaultBaselines having the structure defined by the following table.
Element | Type | Occurs | Description |
---|---|---|---|
![]() |
1..1 | ||
ns:designMode | xs:boolean | 0..1 | |
ns:auth | ns:AuthInfo | 0..1 | |
ns:packageId | xs:string | 0..1 | |
ns:vaultBaselineIds | xs:string | 0..1 | |
The output of this method is the document element ns:unrelateVaultBaselinesResponse having the structure defined by the following table.
Element | Type | Occurs | Description |
---|---|---|---|
![]() |
1..1 | ||
ns:return | ns:VaultBaselineInfo | 0..* | |
Name | Content | Description |
---|---|---|
VaultServiceException | ns:VaultServiceException |
Restricting xs:anyType
Contains elements as defined in the following table.
Component | Type | Occurs | Description |
---|