Publication date: October 2011
Copyright © 2011 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 |
DeployUnitService | Serena Release Manager Deployment Unit 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. |
copyAppReleases2ReleaseTrain | Copy related application releases from input release train into target release train, with or without release package information. |
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 filed to specified parent ID 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. |
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 successful. |
Name | Content | Description |
---|---|---|
RLMUtilServiceFaultMessage | ns:RLMUtilServiceFaultMessage |
Copy related application releases from input release train into target release train, with or without release package information.
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 | Identifier of input release train from which application releases should be copied. |
ns:targetReleaseTrainItemId | xs:string | 0..1 | Identifier of target release train to which application releases should be copied. |
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 successful. |
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 | Identifier of source deployment process template, from which tasks will be copied. |
ns:targetReleasePackageItemId | xs:string | 0..1 | Identifier of target release package, to which tasks will be copied. |
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 successful. |
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 | Identifier of release package from which we should copy tasks. |
ns:inputStageId | xs:string | 0..1 | Identifier of stage from which we should copy tasks. |
ns:inputReleaseTemplateItemId | xs:string | 0..1 | Identifier of template from which we should copy tasks. |
ns:targetReleaseTemplateItemId | xs:string | 0..1 | Identifier of template to which we should copy tasks. |
ns:targetTemplateStageId | xs:string | 0..1 | Identifier 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 successful. |
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 | Identifier of deployment process template. |
ns:releasePackageItemId | xs:string | 0..1 | Identifier of release package. |
ns:stageId | xs:string | 0..1 | Identifier of stage. |
ns:taskIds | xs:string | 0..1 | Identifier 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 successful. |
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 or checked. |
ns:sequenceNumber | xs:integer | 0..1 | Number of sequence to run or 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 or check. |
ns:currentSequence | xs:integer | 0..1 | Currently sequence number being processed. |
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 filed 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 |
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. |
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: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 |
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 |
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: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: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
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 successful. |
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 parent.
Type xs:string
Element ns:relateChildrenRecords
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 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 | Identifier of input release train from which application releases should be copied. |
ns:targetReleaseTrainItemId | xs:string | 0..1 | Identifier of target release train to which application releases should be copied. |
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 successful. |
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 | Identifier of source deployment process template, from which tasks will be copied. |
ns:targetReleasePackageItemId | xs:string | 0..1 | Identifier of target release package, to which tasks will be copied. |
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 successful. |
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 | Identifier of release package from which we should copy tasks. |
ns:inputStageId | xs:string | 0..1 | Identifier of stage from which we should copy tasks. |
ns:inputReleaseTemplateItemId | xs:string | 0..1 | Identifier of template from which we should copy tasks. |
ns:targetReleaseTemplateItemId | xs:string | 0..1 | Identifier of template to which we should copy tasks. |
ns:targetTemplateStageId | xs:string | 0..1 | Identifier 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 successful. |
Whether to copy or not release packages from copied application releases. Default - false.
Type xs:boolean
Element ns:copyAppReleases2ReleaseTrain
Currently sequence number being processed.
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 | Identifier of deployment process template. |
ns:releasePackageItemId | xs:string | 0..1 | Identifier of release package. |
ns:stageId | xs:string | 0..1 | Identifier of stage. |
ns:taskIds | xs:string | 0..1 | Identifier 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 successful. |
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 or checked. |
ns:sequenceNumber | xs:integer | 0..1 | Number of sequence to run or 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 or check. |
ns:currentSequence | xs:integer | 0..1 | Currently sequence number being processed. |
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 emptied.
Type xs:string
Element ns:unrelateChildrenRecords
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. |
Identifier of release package
from which we should copy tasks.
Type xs:string
Element ns:copyDeploymentTasks2Template
Identifier of source deployment process template, from which tasks will be copied.
Type xs:string
Identifier of template from which we
should copy tasks.
Type xs:string
Element ns:copyDeploymentTasks2Template
Identifier of input release train from which application releases should be copied.
Type xs:string
Element ns:copyAppReleases2ReleaseTrain
Identifier of stage from which we
should copy tasks.
Type xs:string
Element ns:copyDeploymentTasks2Template
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:relateRecordsInBothDirections
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. |
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. |
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 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
Identifier 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
Identifier 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 successful.
Type xs:string
Service execution message log - empty if everything is successful.
Type xs:string
Service execution message log - empty if everything is successful.
Type xs:string
Service execution message log - empty if everything is successful.
Type xs:string
Service execution message log - empty if everything is successful.
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
List of related children 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 or check.
Type xs:integer
Element ns:deployReleasePackage
Either current, next, or previous sequence should be run or checked.
Type ns:SequenceTypes
Value | Description |
---|---|
CURRENT | |
NEXT | |
PREVIOUS | |
LAST |
Element ns:deployReleasePackage
Identifier of stage.
Type xs:string
Element ns:deleteDeploymentTasks
Name of the table.
Type xs:string
Element ns:relateChildrenRecords
Name of the table.
Type xs:string
Element ns:unrelateChildrenRecords
Identifier of target release package, to which tasks will be copied.
Type xs:string
Identifier of template to which we
should copy tasks.
Type xs:string
Element ns:copyDeploymentTasks2Template
Identifier of target release train to which application releases should be copied.
Type xs:string
Element ns:copyAppReleases2ReleaseTrain
Identifier 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
Identifier 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 or 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:unrelateChildrenRecords
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: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 |
---|---|
getBuildVersion | Returns build version for Release Requests Web service. |
getInterfaceVersion | Returns interface version for Release Requests Web service. |
getRelatedRequestProjects | Returns related projects for specified release package. |
getRelatedRequests | Returns related requests for specified release package. |
getRequestProjects | Returns projects. |
getRequests | Returns requests from registered request providers. |
relateRequestProjects | Relates specified project to specified release package. |
relateRequests | Relates specified requests to specified release package. |
unRelateRequestProjects | Un-relates specified project from specified release package. |
unRelateRequests | Un-relates specified request from specified release package. |
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 |
Returns related projects for 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 |
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 |
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 | Identifier of release package. |
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 |
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 | Identifier of release package. |
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 |
Name | Description |
---|---|
ns:AuthInfo | |
ns:ProjectInfo | |
ns:RequestInfo |
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 getRequests]
Element ns:auth [element relateRequests]
Restricting xs:anyType
Contains elements as defined in the following table.
Component | Type | Occurs | Description |
---|---|---|---|
1..1 | |||
ns:id | xs:string | 0..1 | Identifier of project. |
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 | Identifier of request. |
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:providerName | xs:string | 0..1 | Provider name. |
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
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
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
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
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
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 | 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 | 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..* | |
Identifier of project.
Type xs:string
Complex Type ns:ProjectInfo
Identifier of request.
Type xs:string
Complex Type ns:RequestInfo
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
Identifier of release package.
Type xs:string
Element ns:relateRequests
Release package ID.
Type xs:string
Element ns:unRelateRequestProjects
Identifier of release package.
Type xs:string
Element ns:unRelateRequests
Project ID list.
Type xs:string
Element ns:relateRequestProjects
Release package ID associated with this project.
Type xs:string
Element ns:unRelateRequestProjects
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 | Identifier of release package. |
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..* | |
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. |
Build version information.
Type xs:string
Element ns:getBuildVersionResponse
Interface version information.
Type xs:string
Element ns:getInterfaceVersionResponse
Type ns:ProjectInfo
Contains elements as defined in the following table.
Component | Type | Occurs | Description |
---|---|---|---|
1..1 | |||
ns:id | xs:string | 0..1 | Identifier of project. |
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 | Identifier of request. |
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:providerName | xs:string | 0..1 | Provider name. |
Element ns:getRelatedRequestsResponse
Type ns:ProjectInfo
Contains elements as defined in the following table.
Component | Type | Occurs | Description |
---|---|---|---|
1..1 | |||
ns:id | xs:string | 0..1 | Identifier of project. |
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 | Identifier of request. |
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:providerName | xs:string | 0..1 | Provider name. |
Element ns:getRequestsResponse
Type ns:ProjectInfo
Contains elements as defined in the following table.
Component | Type | Occurs | Description |
---|---|---|---|
1..1 | |||
ns:id | xs:string | 0..1 | Identifier of project. |
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 | Identifier of request. |
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:providerName | xs:string | 0..1 | Provider name. |
Element ns:relateRequestsResponse
Type ns:ProjectInfo
Contains elements as defined in the following table.
Component | Type | Occurs | Description |
---|---|---|---|
1..1 | |||
ns:id | xs:string | 0..1 | Identifier of project. |
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 | Identifier of request. |
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:providerName | xs:string | 0..1 | Provider name. |
Element ns:unRelateRequestsResponse
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 | Identifier of release package. |
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..* | |
Serena Release Manager Deployment Unit Service
SOAP
Document
Name | Description |
---|---|
getBuildVersion | Returns build version for Deploy Unit web service. |
getDeploymentArea | Returns list of deployment areas. |
getDeploymentStages | Returns list of available deployment stages. |
getDeployUnitProjects | Returns deploy units projects. |
getDeployUnits | Returns list of available deploy units separated by commas. |
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. |
getRelatedDeployUnitProjects | Returns list of related deployment unit projects. |
getRelatedDeployUnits | Returns list of related deploy units. |
relateDeployUnitProjects | Relates deployment unit projects to specified release package. |
relateDeployUnits | Relate specified deploy units to specified release package. |
unRelateDeployUnitProjects | Un-relate deployment unit projects. |
unRelateDeployUnits |
Returns build version for Deploy Unit 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 |
---|---|---|
DeployUnitServiceException | ns:DeployUnitServiceException |
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:unitIds | xs:string | 0..1 | Identifiers of deploy units 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 |
---|---|---|
DeployUnitServiceException | ns:DeployUnitServiceException |
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:unitIds | xs:string | 0..1 | Identifiers of deploy units 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 |
---|---|---|
DeployUnitServiceException | ns:DeployUnitServiceException |
Returns deploy units projects.
urn:getDeployUnitProjects
Document
The input of this method is the document element ns:getDeployUnitProjects 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:getDeployUnitProjectsResponse having the structure defined by the following table.
Element | Type | Occurs | Description |
---|---|---|---|
1..1 | |||
ns:return | ns:ProjectInfo | 0..* | |
Name | Content | Description |
---|---|---|
DeployUnitServiceException | ns:DeployUnitServiceException |
Returns list of available deploy units separated by commas.
urn:getDeployUnits
Document
The input of this method is the document element ns:getDeployUnits 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:getDeployUnitsResponse having the structure defined by the following table.
Element | Type | Occurs | Description |
---|---|---|---|
1..1 | |||
ns:return | ns:DeployUnitInfo | 0..* | |
Name | Content | Description |
---|---|---|
DeployUnitServiceException | ns:DeployUnitServiceException |
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 |
---|---|---|
DeployUnitServiceException | ns:DeployUnitServiceException |
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 |
---|---|---|
DeployUnitServiceException | ns:DeployUnitServiceException |
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 |
---|---|---|
DeployUnitServiceException | ns:DeployUnitServiceException |
Returns list of related deployment unit projects.
urn:getRelatedDeployUnitProjects
Document
The input of this method is the document element ns:getRelatedDeployUnitProjects 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:getRelatedDeployUnitProjectsResponse having the structure defined by the following table.
Element | Type | Occurs | Description |
---|---|---|---|
1..1 | |||
ns:return | ns:ProjectInfo | 0..* | |
Name | Content | Description |
---|---|---|
DeployUnitServiceException | ns:DeployUnitServiceException |
Returns list of related deploy units.
urn:getRelatedDeployUnits
Document
The input of this method is the document element ns:getRelatedDeployUnits 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:getRelatedDeployUnitsResponse having the structure defined by the following table.
Element | Type | Occurs | Description |
---|---|---|---|
1..1 | |||
ns:return | ns:DeployUnitInfo | 0..* | |
Name | Content | Description |
---|---|---|
DeployUnitServiceException | ns:DeployUnitServiceException |
Relates deployment unit projects to specified release package.
urn:relateDeployUnitProjects
Document
The input of this method is the document element ns:relateDeployUnitProjects 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. |
The output of this method is the document element ns:relateDeployUnitProjectsResponse having the structure defined by the following table.
Element | Type | Occurs | Description |
---|---|---|---|
1..1 | |||
ns:return | ns:ProjectInfo | 0..* | |
Name | Content | Description |
---|---|---|
DeployUnitServiceException | ns:DeployUnitServiceException |
Relate specified deploy units to specified release package.
urn:relateDeployUnits
Document
The input of this method is the document element ns:relateDeployUnits 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:deployUnitIds | xs:string | 0..1 | Identifiers of deploy units separated by commas. |
The output of this method is the document element ns:relateDeployUnitsResponse having the structure defined by the following table.
Element | Type | Occurs | Description |
---|---|---|---|
1..1 | |||
ns:return | ns:DeployUnitInfo | 0..* | |
Name | Content | Description |
---|---|---|
DeployUnitServiceException | ns:DeployUnitServiceException |
Un-relate deployment unit projects.
urn:unRelateDeployUnitProjects
Document
The input of this method is the document element ns:unRelateDeployUnitProjects 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:unRelateDeployUnitProjectsResponse having the structure defined by the following table.
Element | Type | Occurs | Description |
---|---|---|---|
1..1 | |||
ns:return | ns:ProjectInfo | 0..* | |
Name | Content | Description |
---|---|---|
DeployUnitServiceException | ns:DeployUnitServiceException |
urn:unRelateDeployUnits
Document
The input of this method is the document element ns:unRelateDeployUnits 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:deployUnitIds | xs:string | 0..1 | |
The output of this method is the document element ns:unRelateDeployUnitsResponse having the structure defined by the following table.
Element | Type | Occurs | Description |
---|---|---|---|
1..1 | |||
ns:return | ns:DeployUnitInfo | 0..* | |
Name | Content | Description |
---|---|---|
DeployUnitServiceException | ns:DeployUnitServiceException |
Name | Description |
---|---|
ns:AuthInfo | Authentication information. |
ns:DeployAreaInfo | |
ns:DeployStageInfo | |
ns:DeployUnitInfo | |
ns:ProjectInfo |
Authentication information.
Restricting xs:anyType
Contains elements as defined in the following table.
Component | Type | Occurs | Description |
---|---|---|---|
1..1 | |||
ns:password | xs:string | 0..1 | Password of authenticating user. |
ns:username | xs:string | 0..1 | Name of authenticating user. |
Element ns:auth [element getDeployUnits]
Element ns:auth [element getGslAreas]
Element ns:auth [element getGslStages]
Restricting xs:anyType
Contains elements as defined in the following table.
Component | Type | Occurs | Description |
---|---|---|---|
1..1 | |||
ns:description | xs:string | 0..1 | Description of deployment area. |
ns:directory | xs:string | 0..1 | Directory of deployment area. |
ns:id | xs:string | 0..1 | Identifier of deployment area. |
ns:name | xs:string | 0..1 | Name of deployment area. |
ns:networkNode | xs:string | 0..1 | Network node of deployment area. |
ns:owner | xs:string | 0..1 | Owner of deployment area. |
ns:providerType | xs:string | 0..1 | Provider name of deployment area. |
ns:stageId | xs:string | 0..1 | Identifier of deployment stage. |
Restricting xs:anyType
Contains elements as defined in the following table.
Component | Type | Occurs | Description |
---|---|---|---|
1..1 | |||
ns:description | xs:string | 0..1 | Description of deployment stage. |
ns:id | xs:string | 0..1 | Identifier of deployment stage. |
ns:name | xs:string | 0..1 | Name of deployment stage. |
ns:owner | xs:string | 0..1 | Owner of deployment stage. |
ns:projects | xs:string | 0..* | Name of projects. |
ns:providerType | xs:string | 0..1 | Name of providers. |
Restricting xs:anyType
Contains elements as defined in the following table.
Component | Type | Occurs | Description |
---|---|---|---|
1..1 | |||
ns:id | xs:string | 0..1 | Identifier of deployment unit. |
ns:name | xs:string | 0..1 | Name of deployment unit. |
ns:projectName | xs:string | 0..1 | Name of deployment unit project. |
ns:providerType | xs:string | 0..1 | Name of provider. |
ns:relatedDeployTask | xs:string | 0..1 | Identifier of related deployment task. |
ns:relatedPackageId | xs:string | 0..1 | Identifier of related release package. |
ns:relatedProjectId | xs:string | 0..1 | Identifier of related project. |
ns:relatedDeployTaskId | xs:string | 0..1 | Identifier of related deployment task. |
Restricting xs:anyType
Contains elements as defined in the following table.
Component | Type | Occurs | Description |
---|---|---|---|
1..1 | |||
ns:id | xs:string | 0..1 | Identifier of project. |
ns:name | xs:string | 0..1 | Name of project. |
ns:owner | xs:string | 0..1 | Owner of project. |
ns:status | xs:string | 0..1 | Status of project. |
ns:type | xs:string | 0..1 | Type of project. |
ns:relatedPackageId | 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. |
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 of authenticating user. |
ns:username | xs:string | 0..1 | Name of authenticating user. |
Element ns:getDeploymentArea
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 of authenticating user. |
ns:username | xs:string | 0..1 | Name of authenticating user. |
Element ns:getDeploymentStages
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 of authenticating user. |
ns:username | xs:string | 0..1 | Name of authenticating user. |
Element ns:getDeployUnitProjects
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 of authenticating user. |
ns:username | xs:string | 0..1 | Name of authenticating user. |
Element ns:getDeployUnits
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 of authenticating user. |
ns:username | xs:string | 0..1 | Name of authenticating user. |
Element ns:getGslAreas
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 of authenticating user. |
ns:username | xs:string | 0..1 | Name of authenticating user. |
Element ns:getGslStages
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 of authenticating user. |
ns:username | xs:string | 0..1 | Name of authenticating user. |
Element ns:getRelatedDeployUnitProjects
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 of authenticating user. |
ns:username | xs:string | 0..1 | Name of authenticating user. |
Element ns:getRelatedDeployUnits
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 of authenticating user. |
ns:username | xs:string | 0..1 | Name of authenticating user. |
Element ns:relateDeployUnitProjects
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 of authenticating user. |
ns:username | xs:string | 0..1 | Name of authenticating user. |
Element ns:relateDeployUnits
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 of authenticating user. |
ns:username | xs:string | 0..1 | Name of authenticating user. |
Element ns:unRelateDeployUnitProjects
Type ns:AuthInfo
Contains elements as defined in the following table.
Component | Type | Occurs | Description |
---|---|---|---|
1..1 | |||
ns:password | xs:string | 0..1 | Password of authenticating user. |
ns:username | xs:string | 0..1 | Name of authenticating user. |
Element ns:unRelateDeployUnits
Identifiers of deploy units separated by commas.
Type xs:string
Element ns:relateDeployUnits
Error message.
Type xs:string
Element ns:DeployUnitServiceException
Restricting xs:anyType
Contains elements as defined in the following table.
Component | Type | Occurs | Description |
---|---|---|---|
1..1 | |||
ns:DeployUnitServiceException | xs:string | 0..1 | Error message. |
Description of deployment area.
Type xs:string
Complex Type ns:DeployAreaInfo
Description of deployment stage.
Type xs:string
Complex Type ns:DeployStageInfo
Run service in design mode. Returns dummy data for use in SBM composer.
Type xs:boolean
Element ns:getDeploymentArea
Run service in design mode. Returns dummy data for use in SBM composer.
Type xs:boolean
Element ns:getDeploymentStages
Run service in design mode. Returns dummy data for use in SBM composer.
Type xs:boolean
Element ns:getDeployUnitProjects
Run service in design mode. Returns dummy data for use in SBM composer.
Type xs:boolean
Element ns:getDeployUnits
Run service in design mode. Returns dummy data for use in SBM composer.
Type xs:boolean
Element ns:getGslAreas
Run service in design mode. Returns dummy data for use in SBM composer.
Type xs:boolean
Element ns:getGslStages
Run service in design mode. Returns dummy data for use in SBM composer.
Type xs:boolean
Element ns:getRelatedDeployUnitProjects
Run service in design mode. Returns dummy data for use in SBM composer.
Type xs:boolean
Element ns:getRelatedDeployUnits
Run service in design mode. Returns dummy data for use in SBM composer.
Type xs:boolean
Element ns:relateDeployUnitProjects
Run service in design mode. Returns dummy data for use in SBM composer.
Type xs:boolean
Element ns:relateDeployUnits
Run service in design mode. Returns dummy data for use in SBM Composer.
Type xs:boolean
Element ns:unRelateDeployUnitProjects
Directory of deployment area.
Type xs:string
Complex Type ns:DeployAreaInfo
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 | |
Restricting xs:anyType
Contains elements as defined in the following table.
Component | 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:unitIds | xs:string | 0..1 | Identifiers of deploy units separated by commas. |
Restricting xs:anyType
Contains elements as defined in the following table.
Component | Type | Occurs | Description |
---|---|---|---|
1..1 | |||
ns:return | ns:DeployAreaInfo | 0..* | |
Restricting xs:anyType
Contains elements as defined in the following table.
Component | 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:unitIds | xs:string | 0..1 | Identifiers of deploy units separated by commas - used for filtering available stages. |
Restricting xs:anyType
Contains elements as defined in the following table.
Component | Type | Occurs | Description |
---|---|---|---|
1..1 | |||
ns:return | ns:DeployStageInfo | 0..* | |
Restricting xs:anyType
Contains elements as defined in the following table.
Component | 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. |
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 | 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). |
Restricting xs:anyType
Contains elements as defined in the following table.
Component | Type | Occurs | Description |
---|---|---|---|
1..1 | |||
ns:return | ns:DeployUnitInfo | 0..* | |
Restricting xs:anyType
Contains elements as defined in the following table.
Component | 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. |
Restricting xs:anyType
Contains elements as defined in the following table.
Component | Type | Occurs | Description |
---|---|---|---|
1..1 | |||
ns:return | ns:DeployAreaInfo | 0..* | |
Restricting xs:anyType
Contains elements as defined in the following table.
Component | 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. |
Restricting xs:anyType
Contains elements as defined in the following table.
Component | Type | Occurs | Description |
---|---|---|---|
1..1 | |||
ns:return | ns:DeployStageInfo | 0..* | |
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. |
Restricting xs:anyType
Contains elements as defined in the following table.
Component | 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). |
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 | 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). |
Restricting xs:anyType
Contains elements as defined in the following table.
Component | Type | Occurs | Description |
---|---|---|---|
1..1 | |||
ns:return | ns:DeployUnitInfo | 0..* | |
Identifier of deployment area.
Type xs:string
Complex Type ns:DeployAreaInfo
Identifier of deployment stage.
Type xs:string
Complex Type ns:DeployStageInfo
Identifier of deployment unit.
Type xs:string
Complex Type ns:DeployUnitInfo
Identifier of project.
Type xs:string
Complex Type ns:ProjectInfo
Name of deployment area.
Type xs:string
Complex Type ns:DeployAreaInfo
Name of deployment stage.
Type xs:string
Complex Type ns:DeployStageInfo
Name of deployment unit.
Type xs:string
Complex Type ns:DeployUnitInfo
Network node of deployment area.
Type xs:string
Complex Type ns:DeployAreaInfo
Owner of deployment area.
Type xs:string
Complex Type ns:DeployAreaInfo
Owner of deployment stage.
Type xs:string
Complex Type ns:DeployStageInfo
Identifier of release package.
Type xs:string
Element ns:getDeploymentArea
Item identifier of release package (in form of table_id:record_id, for example 1001:11) - used for filtering available stages.
Type xs:string
Element ns:getDeploymentStages
Item identifier of release package (in form of table_id:record_id, for example 1001:11).
Type xs:string
Element ns:getDeployUnits
Item identifier of release package (in form of table_id:record_id, for example 1001:11).
Type xs:string
Element ns:getRelatedDeployUnitProjects
Item identifier of release package (in form of table_id:record_id, for example 1001:11).
Type xs:string
Element ns:getRelatedDeployUnits
Item identifier of release package (in form of table_id:record_id, for example 1001:11).
Type xs:string
Element ns:relateDeployUnitProjects
Item identifier of release package (in form of table_id:record_id, for example 1001:11).
Type xs:string
Element ns:relateDeployUnits
Item identifier of release package (in form of table_id:record_id, for example 1001:11).
Type xs:string
Element ns:unRelateDeployUnitProjects
Password of authenticating user.
Type xs:string
Complex Type ns:AuthInfo
Identifiers of deployment unit projects separated by commas.
Type xs:string
Element ns:relateDeployUnitProjects
Identifiers of projects that should be unrelated from specified package.
Type xs:string
Element ns:unRelateDeployUnitProjects
Name of project used for filtering available stages.
Type xs:string
Element ns:getDeploymentStages
Name of deployment unit project.
Type xs:string
Complex Type ns:DeployUnitInfo
Name of projects.
Type xs:string
Complex Type ns:DeployStageInfo
Provider name of deployment area.
Type xs:string
Complex Type ns:DeployAreaInfo
Name of providers.
Type xs:string
Complex Type ns:DeployStageInfo
Name of provider.
Type xs:string
Complex Type ns:DeployUnitInfo
Identifier of related deployment task.
Type xs:string
Complex Type ns:DeployUnitInfo
Identifier of related deployment task.
Type xs:string
Complex Type ns:DeployUnitInfo
Restricting xs:anyType
Contains elements as defined in the following table.
Component | 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. |
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 | 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:deployUnitIds | xs:string | 0..1 | Identifiers of deploy units separated by commas. |
Restricting xs:anyType
Contains elements as defined in the following table.
Component | Type | Occurs | Description |
---|---|---|---|
1..1 | |||
ns:return | ns:DeployUnitInfo | 0..* | |
Identifier of related release package.
Type xs:string
Complex Type ns:DeployUnitInfo
Item identifier of release package (in form of table_id:record_id, for example 1001:11).
Type xs:string
Complex Type ns:ProjectInfo
Identifier of related project.
Type xs:string
Complex Type ns:DeployUnitInfo
Type ns:DeployAreaInfo
Contains elements as defined in the following table.
Component | Type | Occurs | Description |
---|---|---|---|
1..1 | |||
ns:description | xs:string | 0..1 | Description of deployment area. |
ns:directory | xs:string | 0..1 | Directory of deployment area. |
ns:id | xs:string | 0..1 | Identifier of deployment area. |
ns:name | xs:string | 0..1 | Name of deployment area. |
ns:networkNode | xs:string | 0..1 | Network node of deployment area. |
ns:owner | xs:string | 0..1 | Owner of deployment area. |
ns:providerType | xs:string | 0..1 | Provider name of deployment area. |
ns:stageId | xs:string | 0..1 | Identifier of deployment stage. |
Element ns:getDeploymentAreaResponse
Type ns:DeployStageInfo
Contains elements as defined in the following table.
Component | Type | Occurs | Description |
---|---|---|---|
1..1 | |||
ns:description | xs:string | 0..1 | Description of deployment stage. |
ns:id | xs:string | 0..1 | Identifier of deployment stage. |
ns:name | xs:string | 0..1 | Name of deployment stage. |
ns:owner | xs:string | 0..1 | Owner of deployment stage. |
ns:projects | xs:string | 0..* | Name of projects. |
ns:providerType | xs:string | 0..1 | Name of providers. |
Element ns:getDeploymentStagesResponse
Type ns:ProjectInfo
Contains elements as defined in the following table.
Component | Type | Occurs | Description |
---|---|---|---|
1..1 | |||
ns:id | xs:string | 0..1 | Identifier of project. |
ns:name | xs:string | 0..1 | Name of project. |
ns:owner | xs:string | 0..1 | Owner of project. |
ns:status | xs:string | 0..1 | Status of project. |
ns:type | xs:string | 0..1 | Type of project. |
ns:relatedPackageId | 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. |
Element ns:getDeployUnitProjectsResponse
Type ns:DeployUnitInfo
Contains elements as defined in the following table.
Component | Type | Occurs | Description |
---|---|---|---|
1..1 | |||
ns:id | xs:string | 0..1 | Identifier of deployment unit. |
ns:name | xs:string | 0..1 | Name of deployment unit. |
ns:projectName | xs:string | 0..1 | Name of deployment unit project. |
ns:providerType | xs:string | 0..1 | Name of provider. |
ns:relatedDeployTask | xs:string | 0..1 | Identifier of related deployment task. |
ns:relatedPackageId | xs:string | 0..1 | Identifier of related release package. |
ns:relatedProjectId | xs:string | 0..1 | Identifier of related project. |
ns:relatedDeployTaskId | xs:string | 0..1 | Identifier of related deployment task. |
Element ns:getDeployUnitsResponse
Type ns:DeployAreaInfo
Contains elements as defined in the following table.
Component | Type | Occurs | Description |
---|---|---|---|
1..1 | |||
ns:description | xs:string | 0..1 | Description of deployment area. |
ns:directory | xs:string | 0..1 | Directory of deployment area. |
ns:id | xs:string | 0..1 | Identifier of deployment area. |
ns:name | xs:string | 0..1 | Name of deployment area. |
ns:networkNode | xs:string | 0..1 | Network node of deployment area. |
ns:owner | xs:string | 0..1 | Owner of deployment area. |
ns:providerType | xs:string | 0..1 | Provider name of deployment area. |
ns:stageId | xs:string | 0..1 | Identifier of deployment stage. |
Element ns:getGslAreasResponse
Type ns:DeployStageInfo
Contains elements as defined in the following table.
Component | Type | Occurs | Description |
---|---|---|---|
1..1 | |||
ns:description | xs:string | 0..1 | Description of deployment stage. |
ns:id | xs:string | 0..1 | Identifier of deployment stage. |
ns:name | xs:string | 0..1 | Name of deployment stage. |
ns:owner | xs:string | 0..1 | Owner of deployment stage. |
ns:projects | xs:string | 0..* | Name of projects. |
ns:providerType | xs:string | 0..1 | Name of providers. |
Element ns:getGslStagesResponse
Interface version number.
Type xs:string
Element ns:getInterfaceVersionResponse
Type ns:ProjectInfo
Contains elements as defined in the following table.
Component | Type | Occurs | Description |
---|---|---|---|
1..1 | |||
ns:id | xs:string | 0..1 | Identifier of project. |
ns:name | xs:string | 0..1 | Name of project. |
ns:owner | xs:string | 0..1 | Owner of project. |
ns:status | xs:string | 0..1 | Status of project. |
ns:type | xs:string | 0..1 | Type of project. |
ns:relatedPackageId | 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. |
Type ns:DeployUnitInfo
Contains elements as defined in the following table.
Component | Type | Occurs | Description |
---|---|---|---|
1..1 | |||
ns:id | xs:string | 0..1 | Identifier of deployment unit. |
ns:name | xs:string | 0..1 | Name of deployment unit. |
ns:projectName | xs:string | 0..1 | Name of deployment unit project. |
ns:providerType | xs:string | 0..1 | Name of provider. |
ns:relatedDeployTask | xs:string | 0..1 | Identifier of related deployment task. |
ns:relatedPackageId | xs:string | 0..1 | Identifier of related release package. |
ns:relatedProjectId | xs:string | 0..1 | Identifier of related project. |
ns:relatedDeployTaskId | xs:string | 0..1 | Identifier of related deployment task. |
Element ns:getRelatedDeployUnitsResponse
Type ns:ProjectInfo
Contains elements as defined in the following table.
Component | Type | Occurs | Description |
---|---|---|---|
1..1 | |||
ns:id | xs:string | 0..1 | Identifier of project. |
ns:name | xs:string | 0..1 | Name of project. |
ns:owner | xs:string | 0..1 | Owner of project. |
ns:status | xs:string | 0..1 | Status of project. |
ns:type | xs:string | 0..1 | Type of project. |
ns:relatedPackageId | 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. |
Type ns:DeployUnitInfo
Contains elements as defined in the following table.
Component | Type | Occurs | Description |
---|---|---|---|
1..1 | |||
ns:id | xs:string | 0..1 | Identifier of deployment unit. |
ns:name | xs:string | 0..1 | Name of deployment unit. |
ns:projectName | xs:string | 0..1 | Name of deployment unit project. |
ns:providerType | xs:string | 0..1 | Name of provider. |
ns:relatedDeployTask | xs:string | 0..1 | Identifier of related deployment task. |
ns:relatedPackageId | xs:string | 0..1 | Identifier of related release package. |
ns:relatedProjectId | xs:string | 0..1 | Identifier of related project. |
ns:relatedDeployTaskId | xs:string | 0..1 | Identifier of related deployment task. |
Element ns:relateDeployUnitsResponse
Type ns:ProjectInfo
Contains elements as defined in the following table.
Component | Type | Occurs | Description |
---|---|---|---|
1..1 | |||
ns:id | xs:string | 0..1 | Identifier of project. |
ns:name | xs:string | 0..1 | Name of project. |
ns:owner | xs:string | 0..1 | Owner of project. |
ns:status | xs:string | 0..1 | Status of project. |
ns:type | xs:string | 0..1 | Type of project. |
ns:relatedPackageId | 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. |
Type ns:DeployUnitInfo
Contains elements as defined in the following table.
Component | Type | Occurs | Description |
---|---|---|---|
1..1 | |||
ns:id | xs:string | 0..1 | Identifier of deployment unit. |
ns:name | xs:string | 0..1 | Name of deployment unit. |
ns:projectName | xs:string | 0..1 | Name of deployment unit project. |
ns:providerType | xs:string | 0..1 | Name of provider. |
ns:relatedDeployTask | xs:string | 0..1 | Identifier of related deployment task. |
ns:relatedPackageId | xs:string | 0..1 | Identifier of related release package. |
ns:relatedProjectId | xs:string | 0..1 | Identifier of related project. |
ns:relatedDeployTaskId | xs:string | 0..1 | Identifier of related deployment task. |
Element ns:unRelateDeployUnitsResponse
Identifier of deployment stage.
Type xs:string
Complex Type ns:DeployAreaInfo
Name of deployment stage.
Type xs:string
Element ns:getDeploymentArea
Name of deployment stage.
Type xs:string
Element ns:getGslAreas
Identifiers of deploy units separated by commas.
Type xs:string
Element ns:getDeploymentArea
Identifiers of deploy units separated by commas - used for filtering available stages.
Type xs:string
Element ns:getDeploymentStages
Restricting xs:anyType
Contains elements as defined in the following table.
Component | 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. |
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 | |
ns:auth | ns:AuthInfo | 0..1 | |
ns:packageId | xs:string | 0..1 | |
ns:deployUnitIds | xs:string | 0..1 | |
Restricting xs:anyType
Contains elements as defined in the following table.
Component | Type | Occurs | Description |
---|---|---|---|
1..1 | |||
ns:return | ns:DeployUnitInfo | 0..* | |
Name of authenticating user.
Type xs:string
Complex Type ns:AuthInfo
Serena Release Manager Deployment Automation Service
SOAP
Document
Name | Description |
---|---|
getApplications | Returns Nolio application list. |
getBuildVersion | Returns build version for Deployment Automation web service. |
getEnvironments | Returns Nolio environment list. |
getInterfaceVersion | Returns interface version for Deployment Automation web service. |
getJobStatus | Returns current job status. |
getParameters | Returns Nolio parameters. |
getProcessChildren | Returns Nolio process children list. |
getProcesses | Returns Nolio process list. |
getServers | Returns Nolio server list. |
startProcessExecution | Start process execution on Nolio server. |
Returns Nolio application list.
urn:getApplications
Document
The input of this method is the document element ns:getApplications 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:authInfo | ns:AuthInfo | 0..1 | Authentication information. |
The output of this method is the document element ns:getApplicationsResponse having the structure defined by the following table.
Element | Type | Occurs | Description |
---|---|---|---|
1..1 | |||
ns:return | xs:string | 0..* | Name of application. |
Name | Content | Description |
---|---|---|
DeploymentAutomationServiceFaultMessage | ns:DeploymentAutomationServiceFaultMessage |
Returns build version for Deployment Automation 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 | Service build version. |
Name | Content | Description |
---|---|---|
DeploymentAutomationServiceFaultMessage | ns:DeploymentAutomationServiceFaultMessage |
Returns Nolio environment list.
urn:getEnvironments
Document
The input of this method is the document element ns:getEnvironments 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:authInfo | ns:AuthInfo | 0..1 | Authentication information. |
ns:application | xs:string | 0..1 | Application name. |
The output of this method is the document element ns:getEnvironmentsResponse having the structure defined by the following table.
Element | Type | Occurs | Description |
---|---|---|---|
1..1 | |||
ns:return | xs:string | 0..* | Name of environment. |
Name | Content | Description |
---|---|---|
DeploymentAutomationServiceFaultMessage | ns:DeploymentAutomationServiceFaultMessage |
Returns interface version for Deployment Automation 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 | Service interface version. |
Name | Content | Description |
---|---|---|
DeploymentAutomationServiceFaultMessage | ns:DeploymentAutomationServiceFaultMessage |
Returns current job status.
urn:getJobStatus
Document
The input of this method is the document element ns:getJobStatus having the structure defined by the following table.
Element | Type | Occurs | Description |
---|---|---|---|
1..1 | |||
ns:authInfo | ns:AuthInfo | 0..1 | Authentication information. |
ns:jobId | xs:long | 0..1 | Job ID. |
The output of this method is the document element ns:getJobStatusResponse having the structure defined by the following table.
Element | Type | Occurs | Description |
---|---|---|---|
1..1 | |||
ns:return | ns:JobStatus | 0..1 | Job status. |
Name | Content | Description |
---|---|---|
DeploymentAutomationServiceFaultMessage | ns:DeploymentAutomationServiceFaultMessage |
Returns Nolio parameters.
urn:getParameters
Document
The input of this method is the document element ns:getParameters 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:authInfo | ns:AuthInfo | 0..1 | Authentication information. |
ns:application | xs:string | 0..1 | Application name. |
ns:environment | xs:string | 0..1 | Environment name. |
ns:process | xs:string | 0..1 | Nolio process name. |
The output of this method is the document element ns:getParametersResponse having the structure defined by the following table.
Element | Type | Occurs | Description |
---|---|---|---|
1..1 | |||
ns:return | xs:string | 0..* | Name of parameter. |
Name | Content | Description |
---|---|---|
DeploymentAutomationServiceFaultMessage | ns:DeploymentAutomationServiceFaultMessage |
Returns Nolio process children list.
urn:getProcessChildren
Document
The input of this method is the document element ns:getProcessChildren 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:authInfo | ns:AuthInfo | 0..1 | Authentication information. |
ns:application | xs:string | 0..1 | Application name. |
ns:environment | xs:string | 0..1 | Environment name. |
ns:process | xs:string | 0..1 | Nolio process name. |
The output of this method is the document element ns:getProcessChildrenResponse having the structure defined by the following table.
Element | Type | Occurs | Description |
---|---|---|---|
1..1 | |||
ns:return | xs:string | 0..* | Name of child process. |
Name | Content | Description |
---|---|---|
DeploymentAutomationServiceFaultMessage | ns:DeploymentAutomationServiceFaultMessage |
Returns Nolio process list.
urn:getProcesses
Document
The input of this method is the document element ns:getProcesses 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:authInfo | ns:AuthInfo | 0..1 | Authentication information. |
ns:application | xs:string | 0..1 | Application name. |
ns:environment | xs:string | 0..1 | Environment name. |
The output of this method is the document element ns:getProcessesResponse having the structure defined by the following table.
Element | Type | Occurs | Description |
---|---|---|---|
1..1 | |||
ns:return | xs:string | 0..* | Name of process. |
Name | Content | Description |
---|---|---|
DeploymentAutomationServiceFaultMessage | ns:DeploymentAutomationServiceFaultMessage |
Returns Nolio server list.
urn:getServers
Document
The input of this method is the document element ns:getServers 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:authInfo | ns:AuthInfo | 0..1 | Authentication information. |
ns:application | xs:string | 0..1 | Application name. |
ns:environment | xs:string | 0..1 | Environment name. |
The output of this method is the document element ns:getServersResponse having the structure defined by the following table.
Element | Type | Occurs | Description |
---|---|---|---|
1..1 | |||
ns:return | ns:ServerInfo | 0..* | |
Name | Content | Description |
---|---|---|
DeploymentAutomationServiceFaultMessage | ns:DeploymentAutomationServiceFaultMessage |
Start process execution on Nolio server.
urn:startProcessExecution
Document
The input of this method is the document element ns:startProcessExecution having the structure defined by the following table.
Element | Type | Occurs | Description |
---|---|---|---|
1..1 | |||
ns:authInfo | ns:AuthInfo | 0..1 | Authorization information. |
ns:processInfo | ns:ProcessInfo | 0..1 | |
ns:sbmItemInfo | ns:SbmItemInfo | 0..1 | |
The output of this method is the document element ns:startProcessExecutionResponse having the structure defined by the following table.
Element | Type | Occurs | Description |
---|---|---|---|
1..1 | |||
ns:return | xs:long | 0..1 | Process execution job ID. |
Name | Content | Description |
---|---|---|
DeploymentAutomationServiceFaultMessage | ns:DeploymentAutomationServiceFaultMessage |
Name | Description |
---|---|
ns:ArrayOfString | |
ns:AuthInfo | |
ns:Entry | |
ns:JobStatus | |
ns:ProcessInfo | |
ns:SbmItemInfo | |
ns:ServerInfo | |
ns:string2stringMap |
Restricting xs:anyType
Contains elements as defined in the following table.
Component | Type | Occurs | Description |
---|---|---|---|
1..1 | |||
ns:string | xs:string | 0..* | |
Element ns:servers [type ProcessInfo]
Restricting xs:anyType
Contains elements as defined in the following table.
Component | Type | Occurs | Description |
---|---|---|---|
1..1 | |||
ns:username | xs:string | 0..1 | User name. |
ns:password | xs:string | 0..1 | Password. |
Element ns:authInfo [element getServers]
Restricting xs:anyType
Contains elements as defined in the following table.
Component | Type | Occurs | Description |
---|---|---|---|
1..1 | |||
ns:key | xs:string | 0..1 | |
ns:value | xs:string | 0..1 | |
Element ns:entry [type string2stringMap]
Restricting xs:anyType
Contains elements as defined in the following table.
Component | Type | Occurs | Description |
---|---|---|---|
1..1 | |||
ns:currentProgress | xs:double | 0..1 | Current progress in %. |
ns:currentStep | xs:string | 0..1 | Current step. |
ns:status | xs:string | 0..1 | Job status. |
Restricting xs:anyType
Contains elements as defined in the following table.
Component | Type | Occurs | Description |
---|---|---|---|
1..1 | |||
ns:applicationName | xs:string | 0..1 | Application name. |
ns:environmentName | xs:string | 0..1 | Environment name. |
ns:parameters | ns:string2stringMap | 0..1 | Parameters. |
ns:processName | xs:string | 0..1 | Process name. |
ns:servers | ns:ArrayOfString | 0..1 | Nolio servers. |
Restricting xs:anyType
Contains elements as defined in the following table.
Component | Type | Occurs | Description |
---|---|---|---|
1..1 | |||
ns:sbmItemInstanceId | xs:string | 0..1 | |
ns:sbmItemObjectType | xs:string | 0..1 | |
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 server. |
ns:type | xs:string | 0..1 | Type of server. |
Restricting xs:anyType
Contains elements as defined in the following table.
Component | Type | Occurs | Description |
---|---|---|---|
1..1 | |||
ns:entry | ns:Entry | 0..* | |
Element ns:parameters [type ProcessInfo]
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 | User name. |
ns:password | xs:string | 0..1 | Password. |
Element ns:getApplications
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 | User name. |
ns:password | xs:string | 0..1 | Password. |
Element ns:getEnvironments
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 | User name. |
ns:password | xs:string | 0..1 | Password. |
Element ns:getJobStatus
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 | User name. |
ns:password | xs:string | 0..1 | Password. |
Element ns:getParameters
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 | User name. |
ns:password | xs:string | 0..1 | Password. |
Element ns:getProcessChildren
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 | User name. |
ns:password | xs:string | 0..1 | Password. |
Element ns:getProcesses
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 | User name. |
ns:password | xs:string | 0..1 | Password. |
Element ns:getServers
Authorization information.
Type ns:AuthInfo
Contains elements as defined in the following table.
Component | Type | Occurs | Description |
---|---|---|---|
1..1 | |||
ns:username | xs:string | 0..1 | User name. |
ns:password | xs:string | 0..1 | Password. |
Element ns:startProcessExecution
Current progress in %.
Type xs:double
Complex Type ns:JobStatus
Error message.
Type xs:string
Restricting xs:anyType
Contains elements as defined in the following table.
Component | Type | Occurs | Description |
---|---|---|---|
1..1 | |||
ns:DeploymentAutomationServiceFaultMessage | xs:string | 0..1 | Error message. |
Enable design mode if set to true.
Type xs:boolean
Element ns:getApplications
Enable design mode if set to true.
Type xs:boolean
Element ns:getEnvironments
Enable design mode if set to true.
Type xs:boolean
Element ns:getParameters
Enable design mode if set to true.
Type xs:boolean
Element ns:getProcessChildren
Enable design mode if set to true.
Type xs:boolean
Element ns:getProcesses
Enable design mode if set to true.
Type xs:boolean
Element ns:getServers
Type ns:Entry
Contains elements as defined in the following table.
Component | Type | Occurs | Description |
---|---|---|---|
1..1 | |||
ns:key | xs:string | 0..1 | |
ns:value | xs:string | 0..1 | |
Complex Type ns:string2stringMap
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:authInfo | 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 | xs:string | 0..* | Name of application. |
Restricting xs:anyType
Contains elements as defined in the following table.
Component | Type | Occurs | Description |
---|---|---|---|
1..1 | |||
ns:return | xs:string | 0..1 | Service build version. |
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:authInfo | ns:AuthInfo | 0..1 | Authentication information. |
ns:application | xs:string | 0..1 | Application name. |
Restricting xs:anyType
Contains elements as defined in the following table.
Component | Type | Occurs | Description |
---|---|---|---|
1..1 | |||
ns:return | xs:string | 0..* | Name of environment. |
Restricting xs:anyType
Contains elements as defined in the following table.
Component | Type | Occurs | Description |
---|---|---|---|
1..1 | |||
ns:return | xs:string | 0..1 | Service interface version. |
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:jobId | xs:long | 0..1 | Job ID. |
Restricting xs:anyType
Contains elements as defined in the following table.
Component | Type | Occurs | Description |
---|---|---|---|
1..1 | |||
ns:return | ns:JobStatus | 0..1 | Job status. |
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:authInfo | ns:AuthInfo | 0..1 | Authentication information. |
ns:application | xs:string | 0..1 | Application name. |
ns:environment | xs:string | 0..1 | Environment name. |
ns:process | xs:string | 0..1 | Nolio process name. |
Restricting xs:anyType
Contains elements as defined in the following table.
Component | Type | Occurs | Description |
---|---|---|---|
1..1 | |||
ns:return | xs:string | 0..* | Name of parameter. |
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:authInfo | ns:AuthInfo | 0..1 | Authentication information. |
ns:application | xs:string | 0..1 | Application name. |
ns:environment | xs:string | 0..1 | Environment name. |
ns:process | xs:string | 0..1 | Nolio process name. |
Restricting xs:anyType
Contains elements as defined in the following table.
Component | Type | Occurs | Description |
---|---|---|---|
1..1 | |||
ns:return | xs:string | 0..* | Name of child process. |
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:authInfo | ns:AuthInfo | 0..1 | Authentication information. |
ns:application | xs:string | 0..1 | Application name. |
ns:environment | xs:string | 0..1 | Environment name. |
Restricting xs:anyType
Contains elements as defined in the following table.
Component | Type | Occurs | Description |
---|---|---|---|
1..1 | |||
ns:return | xs:string | 0..* | Name of process. |
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:authInfo | ns:AuthInfo | 0..1 | Authentication information. |
ns:application | xs:string | 0..1 | Application name. |
ns:environment | xs:string | 0..1 | Environment name. |
Restricting xs:anyType
Contains elements as defined in the following table.
Component | Type | Occurs | Description |
---|---|---|---|
1..1 | |||
ns:return | ns:ServerInfo | 0..* | |
Parameters.
Type ns:string2stringMap
Contains elements as defined in the following table.
Component | Type | Occurs | Description |
---|---|---|---|
1..1 | |||
ns:entry | ns:Entry | 0..* | |
Complex Type ns:ProcessInfo
Nolio process name.
Type xs:string
Element ns:getProcessChildren
Type ns:ProcessInfo
Contains elements as defined in the following table.
Component | Type | Occurs | Description |
---|---|---|---|
1..1 | |||
ns:applicationName | xs:string | 0..1 | Application name. |
ns:environmentName | xs:string | 0..1 | Environment name. |
ns:parameters | ns:string2stringMap | 0..1 | Parameters. |
ns:processName | xs:string | 0..1 | Process name. |
ns:servers | ns:ArrayOfString | 0..1 | Nolio servers. |
Element ns:startProcessExecution
Name of application.
Type xs:string
Element ns:getApplicationsResponse
Service build version.
Type xs:string
Element ns:getBuildVersionResponse
Name of environment.
Type xs:string
Element ns:getEnvironmentsResponse
Service interface version.
Type xs:string
Element ns:getInterfaceVersionResponse
Job status.
Type ns:JobStatus
Contains elements as defined in the following table.
Component | Type | Occurs | Description |
---|---|---|---|
1..1 | |||
ns:currentProgress | xs:double | 0..1 | Current progress in %. |
ns:currentStep | xs:string | 0..1 | Current step. |
ns:status | xs:string | 0..1 | Job status. |
Element ns:getJobStatusResponse
Name of parameter.
Type xs:string
Element ns:getParametersResponse
Name of child process.
Type xs:string
Element ns:getProcessChildrenResponse
Name of process.
Type xs:string
Element ns:getProcessesResponse
Type ns:ServerInfo
Contains elements as defined in the following table.
Component | Type | Occurs | Description |
---|---|---|---|
1..1 | |||
ns:name | xs:string | 0..1 | Name of server. |
ns:type | xs:string | 0..1 | Type of server. |
Element ns:getServersResponse
Process execution job ID.
Type xs:long
Element ns:startProcessExecutionResponse
Type ns:SbmItemInfo
Contains elements as defined in the following table.
Component | Type | Occurs | Description |
---|---|---|---|
1..1 | |||
ns:sbmItemInstanceId | xs:string | 0..1 | |
ns:sbmItemObjectType | xs:string | 0..1 | |
Element ns:startProcessExecution
Nolio servers.
Type ns:ArrayOfString
Contains elements as defined in the following table.
Component | Type | Occurs | Description |
---|---|---|---|
1..1 | |||
ns:string | xs:string | 0..* | |
Complex Type ns:ProcessInfo
Restricting xs:anyType
Contains elements as defined in the following table.
Component | Type | Occurs | Description |
---|---|---|---|
1..1 | |||
ns:authInfo | ns:AuthInfo | 0..1 | Authorization information. |
ns:processInfo | ns:ProcessInfo | 0..1 | |
ns:sbmItemInfo | ns:SbmItemInfo | 0..1 | |
Restricting xs:anyType
Contains elements as defined in the following table.
Component | Type | Occurs | Description |
---|---|---|---|
1..1 | |||
ns:return | xs:long | 0..1 | Process execution job ID. |