Release Management SOAP web services
You create, modify, and query release records by using the Release Management interface forms. When you create a release, you can perform the following actions:
- Relate the release with an existing CI entry.
- Create a work information entry.
- Use an existing release template.
You can also manage Manifest Relationships by using the ReleaseManifestInterface form, which enables you to create, update, and remove these associations.
Release_Submit_Service
To create a release request, either use web services or use the RMS:ReleaseInterface_Create form.
The following table describes the values required to submit a release request by using the RMS:ReleaseInterface_Create form:
DB field on interface form | Displayed on web services | Field value | Notes |
|---|---|---|---|
z1D Action | Action | CREATE | Keyword triggers workflow that initiates the create operation. |
Description | Description | Not applicable | Not applicable |
First Name | First_Name | Not applicable | Not applicable |
Impact | Impact | Not applicable | Not applicable |
Last Name | Last_Name | Not applicable | Not applicable |
Location Company | Location_Company | Not applicable | Not applicable |
Release Status | Release_Status | Not applicable | Not applicable |
Risk Level | Risk_Level | Not applicable | Not applicable |
Urgency | Urgency | Not applicable | Not applicable |
Company | Company | Not applicable | This value is the Requester's Support Company. |
Business Justification | Business_Justification | Not applicable | Not applicable |
Target Date | Target_Date | Not applicable | Not applicable |
While you are using this web service, and if you are not using auto assignment, you should type the Release Manager Login ID instead of the Release Manager's full name into the Release_Manager_LoginID field.
Release_GetWorkInfoList function
The following table lists the values needed to retrieve a list of work info records for a list of releases:
Web service field | Field value | Notes |
|---|---|---|
Release_Number | Not applicable | This field is used only by the HelpDesk_Query_Service operation. |
Qualification | AR System qualification | This field is used only by the HelpDesk_QueryList_ Service operation. |
The following table lists the output values:
Web service field | Notes |
|---|---|
ReleaseID | Release number that the work info belongs to. |
WorkInfoCommSource | Not applicable |
WorkInfoInstanceID | Not applicable |
WorkInfoNotes | Not applicable |
WorkInfoStatus | Not applicable |
WorkInfoSubmitDate | Not applicable |
WorkInfoSummary | Not applicable |
WorkInfoType | Not applicable |
WorkInfoAttachment1Data | Attachment Information. |
WorkInfoAttachment1Name | Not applicable |
WorkInfoAttachment1OrigSize | Not applicable |
WorkInfoAttachment2Data | Not applicable |
WorkInfoAttachment2Name | Not applicable |
WorkInfoAttachment2OrigSize | Not applicable |
WorkInfoAttachment3Data | Not applicable |
WorkInfoAttachment3Name | Not applicable |
WorkInfoAttachment3OrigSize | Not applicable |
GetListOfRelatedReleases function
The GetListOfRelatedReleases function retrieves a list of related releases.
The following table lists the optional field values:
Web service field | Field value | Notes |
|---|---|---|
Release_Number | Not applicable | This field is used only by the HelpDesk_Query_Service operation. |
Qualification | AR System qualification | This field is used only by the HelpDesk_QueryList_ Service operation. |
The following table lists the output values:
Web service field | Notes |
|---|---|
Association_Type01 | The relationship type from the release to its related record. |
Request_ID01 | The ID of the record related to the release. |
Request_Type01 | The type of ticket related to the release. |
Modify and query release operations
To modify and query releases along with multiple relationships and work information entries, either use web services or use the RMS:ReleaseInterface, RMS:Associations, and RMS:WorkLog forms.
These forms and web services support the following operations:
- UpdateReleaseOnly—Updates release only.
- QueryReleaseOnly—Queries release only.
- UpdateReleaseAndRelationships—Updates release and relationships.
- QueryReleasePlusRelationships—Queries release and relationships.
- UpdateReleaseAndWorkInfo—Updates release and work information entries.
- QueryReleaseAndWorkInfo—Queries release and work information entries.
- UpdateReleaseAndRelationshipsAndWorkInfo—Updates release, relationships, and work information entries.
- QueryReleasePlusRelationshipsAndWorkInfo—Queries release, relationships, and work information entries.
The following table describes the values required to update releases by using the RMS:ReleaseInterface form:
DB field on interface form | Displayed on web services | Field value | Notes |
|---|---|---|---|
ReleaseID | ReleaseID | Not applicable | Not applicable |
First Name | FirstName | Not applicable | Not applicable |
Last Name | LastName | Not applicable | Not applicable |
Location Company | LocationCompany | Not applicable | Not applicable |
Impact | Impact | Not applicable | Not applicable |
Urgency | Urgency | Not applicable | Not applicable |
Description | Description | Not applicable | Not applicable |
Release Status | ReleaseStatus | Not applicable | Not applicable |
Company | RequesterSupportCompany | Not applicable | Not applicable |
The following table describes the values required to update relationships by using the RMS:Associations form:
DB field on interface form | Displayed on web services | Field value | Notes |
|---|---|---|---|
Status | RelationshipsStatus | Enabled | Not applicable |
Request ID01 | RelatedItemID | Not applicable | Reconciliation ID for the CI that relates to the release request. |
Form Name01 | RelatedItemSource | Not applicable | CI form name that relates to the release request. |
Request Type01 | RelatedItemType | Configuration Item | Not applicable |
Request Description01 | Description | Not applicable | CI name that relates to the release request. |
Association Type01 | RelationshipType | Related to | Not applicable |
Form Name02 | FormName02 | RMS:Release | Not applicable |
Request ID02 | ReleaseID | Not applicable | Release ID for relationships. |
The following table describes the values required to add work information entries by using the RMS:WorkLog form:
DB field on interface form | Displayed on web services | Field value | Notes |
|---|---|---|---|
Work Log Type | WorkInfoType | Not applicable | Not applicable |
Description | WorkInfoSummary | Not applicable | Not applicable |
Secure Work Log | WorkInfoSecureLog | Not applicable | Not applicable |
Communication Source | WorkInfoCommSource | Not applicable | Not applicable |
CreateManifest
To create manifest associations, either use web services or use the RMS:ReleaseManifestInterface form.
The following table describes the values that are required to create release manifest associations by using the RMS:ReleaseManifestInterface form:
DB field on interface form | Displayed on web services | Field value | Notes |
|---|---|---|---|
z1D Action | z1D_Action | CREATE | Keyword triggers workflow that initiates the create operation. |
Submitter | Submitter | Not applicable | Not applicable |
Status | Status | Enabled | Not applicable |
Short Description | Short_Description | Not applicable | Not applicable |
Form Name01 | Form_Name01 | CHG:Infrastructure Change | Not applicable |
Form Name02 | Form_Name02 | RMS:Release | Not applicable |
Request ID01 | Request_ID01 | Change Request ID | Not applicable |
Request ID02 | Request_ID02 | Release Request ID | Not applicable |
Association Type01 | Association_Type01 | Consists of | Not applicable |
Request Type01 | Request_Type01 | Infrastructure Change | Not applicable |
UpdateManifest
To update Manifest Associations with milestone and phase information, either use web services or use the RMS:ReleaseManifestInterface form.
The following table describes the values that are required to update release manifest associations by using the RMS:ReleaseManifestInterface form:
DB field on interface form | Displayed on web services | Field value | Notes |
|---|---|---|---|
z1D Action | z1D_Action | MODIFY | Keyword triggers workflow that initiates the modify operation. |
Milestone | Milestone | Not applicable | Not applicable |
Form Name01 | Form_Name01 | CHG:Infrastructure Change | Not applicable |
Form Name02 | Form_Name02 | RMS:Release | Not applicable |
Request ID01 | Request_ID01 | Change Request ID | Not applicable |
Request ID02 | Request_ID02 | Release Request ID | Not applicable |
Request Description01 | Request_Description01 | Not applicable | Not applicable |
Request Type01 | Request_Type01 | Infrastructure Change | Not applicable |
RemoveManifest
To remove manifest associations, either use web services or use the RMS:ReleaseManifestInterface form.
The following table describes the values that are required to remove a release manifest associations by using the RMS:ReleaseManifestInterface form:
DB field on interface form | Displayed on web services | Field value | Notes |
|---|---|---|---|
z1D Action | z1D_Action | DELETE | Keyword triggers workflow that initiates the delete operation. |
Milestone | Milestone | Not applicable | Not applicable |
Form Name01 | Form_Name01 | CHG:Infrastructure Change | Not applicable |
Form Name02 | Form_Name02 | RMS:Release | Not applicable |
Request ID01 | Request_ID01 | Change Request ID | Not applicable |
Request ID02 | Request_ID02 | Release Request ID | Not applicable |
Request Description01 | Request_Description01 | Not applicable | Not applicable |
Request Type01 | Request_Type01 | Infrastructure Change | Not applicable |
Create release relationships
To create a release relationship, either use web services or use the RMS:RelationshipsInterface_Create form.
The following table describes the values required to create a release relationship by using the RMS:RelationshipsInterface_Create form:
DB field on interface form | Displayed on web services | Field value | Notes |
|---|---|---|---|
Status | Status | Not applicable | Active |
ReleaseID | ReleaseID | Not applicable | Release ID used to relate the relationships. |
Form Name01 | Form_Name01 | Not applicable | CI form name that relates with a release request. |
Form Name02 | Form_Name02 | RMS:Release | Not applicable |
ID01 | ID01 | Not applicable | Reconciliation ID for the CI that relates with the release request. |
ID02 | ID02 | Not applicable | Release ID used to relate relationships. |
Request Description01 | Request_Description01 | Not applicable | CI name that relates with a release request. |
Association Type | Assocation_Type | Related to | Not applicable |
Request Type01 | Request_Type01 | Configuration Item | Not applicable |