Change Management SOAP web services
You create and modify infrastructure change records by using the Change Management interface forms.
- When you create an infrastructure change, you can perform the following actions:
- Relate the change with an existing CI entry.
- Create a work information entry.
- When you modify an infrastructure change, you can also create a work information record.
Change_Submit_Service
To create an Infrastructure Change record, either use web services or use the interface form.
The following tables describe the values required to create an Infrastructure Change record by using the CHG:ChangeInterface_Create form. These tables list the interface field value and its corresponding web service value.
DB field on interface form | Displayed on web services | Field value | Notes |
|---|---|---|---|
z1D_Action | Action | CREATE | Keyword triggers workflow that initiates the submit operation. |
Description | Summary | Not applicable | Not applicable |
Status | Status | Not applicable | Not applicable |
Impact | Impact | Not applicable | Not applicable |
Urgency | Urgency | Not applicable | Not applicable |
Change Type | Change_Type | Not applicable | Not applicable |
Timing | Class | Not applicable | Not applicable |
Risk Level | Risk_Level | Not applicable | Not applicable |
Company | Company | Not applicable | Not applicable |
Location Company | Location_Company | Not applicable | Not applicable |
First Name | First_Name | Not applicable | Not applicable |
Last Name | Last_Name | Not applicable | Not applicable |
Important
When you use a change template to create a change request, the field values from the interface form overwrite the values that are defined in the change template. The only exception is that if the interface form passes a null value, the template value is replaced. For example, if the product category in the template is Hardware and the interface form passes a null value, the change product category is set to Hardware.
The following table lists the optional field values:
DB field on interface form | Displayed on web services | Notes |
|---|---|---|
Detailed Description | Notes | Displayed on the main form as Notes. |
Environment | Not applicable | Not applicable |
Reason For Change | Reason_For_Change | Not applicable |
Lead Time | Lead_Time | Not applicable |
Performance Rating | Performance_Rating | Not applicable |
Business Justification | Business_Justification | Not applicable |
Product Cat Tier 1 (2) | Product_Categ_Tier_1 | Not applicable |
Product Cat Tier 2 (2) | Product_Categ_Tier_2 | Not applicable |
Product Cat Tier 3 (2) | Product_Categ_Tier_3 | Not applicable |
Product Name (2) | Product_Name | Not applicable |
Product Model/Version (2) | Product_Model_ Version | Not applicable |
Manufacturer (2) | Manufacturer | Not applicable |
Categorization Tier 1 | Categorization_Tier_1 | Not applicable |
Categorization Tier 2 | Categorization_Tier_2 | Not applicable |
Categorization Tier 3 | Categorization_Tier_3 | Not applicable |
Requested Start Date | Requested_Start_Date | Not applicable |
Request End Date | Requested_End_Date | Not applicable |
Scheduled Start Date | Scheduled_Start_Date | Not applicable |
Scheduled End Date | Scheduled_End_Date | Not applicable |
Actual Start Date | Actual_Start_Date | Not applicable |
Actual End Date | Actual_End_Date | Not applicable |
In Production | In_Production_Date | Not applicable |
Company3 | Chg_Manager_Support_Company | Used for assignment on the CHG:Infrastructure Change form. |
Support Organization | Chg_Manager_Support_Organization | Used for assignment on the CHG:Infrastructure Change form. |
Support Group Name | Chg_Manager_Support_Group | Used for assignment on the CHG:Infrastructure Change form. |
CAB Manager (Change Co-ord) | Change_Manager | Used for assignment on the CHG:Infrastructure Change form. |
ChgImpCpy | Chg_Implementer_ Support_Company | Used for assignment on the CHG:Infrastructure Change form. |
ChgImpOrg | Chg_Implementer_ Support_Organization | Used for assignment on the CHG:Infrastructure Change form. |
ChgImpGrp | Chg_Implementer_ Support_Group | Used for assignment on the CHG:Infrastructure Change form. |
ChgImp | Change_Implementer | Used for assignment on the CHG:Infrastructure Change form. |
ASCPY | Chg_Assignee_Support_Company | Used for assignment on the CHG:Infrastructure Change form. |
ASORG | Chg_Assignee_Support_Organization | Used for assignment on the CHG:Infrastructure Change form. |
ASGRP | Chg_Assignee_Support_Group | Used for assignment on the CHG:Infrastructure Change form. |
ASCHG | Change_Coordinator | Used for assignment on the CHG:Infrastructure Change form. |
Change Target Date | Change_Target_Date | Used for tracking the approximate target date for completion of a change request. |
CI Name | CI_Name | For more information, see
Associating entries with configuration items
|
Lookup Keyword | Lookup_Keyword | Not applicable |
z1D_WorklogDetails | Work_Info_Summary | Required for creating work information. |
z1D_Activity Type | Work_Info_Type | Optional for creating work information. The default value is General Information. If left null. |
Secure Work Log | Work_Info_Locked | Optional for creating work information. The default value is No. If left null. |
View Access | Work_Info_View_ Access | Optional for creating work information. The default value is Internal. If left null. |
z1D_Details | Work_Info_Notes | Optional for creating work information. |
z1D_ActivityDate_tab | Work_Info_Date | Optional for creating work information. |
z1D_ CommunicationSource | Work_Info_Source | Optional for creating work information. |
Phone Number | Req_by_Phone_Number | Not applicable |
Organization | Req_By_Organization | Not applicable |
Department | Req_By_Department | Not applicable |
Support Group Name2 | Req_By_Group | Not applicable |
The following table lists the fields set through workflow:
DB field on interface form | Notes |
|---|---|
Infrastructure Change ID | Not applicable |
Priority | Not applicable |
RequesterLoginID | Set to $USER$ by default (currently not a web service input). |
Submitter | Set to $USER$. |
Change_Modify_Service
Use the Infrastructure Change ID as the search criteria to find, and then modify a specific change. You perform modifications through the CHG:ChangeInterface form.
Important
When you use web services, you must use the interface form to populate all the fields mapped to the CHG:ChangeInterface form; otherwise, a null value is sent, and the current values are overwritten.
The following table lists the input field values:
DB field on interface form | Displayed on web services | Field value | Notes |
|---|---|---|---|
z1D_Action | Action | MODIFY | Keyword triggers workflow that initiates the modify operation. |
Infrastructure Change ID | Infrastructure_Change_ID | Not applicable | Used as the qualification to search against the main form. |
Change Type | Change_Type | Not applicable | Not applicable |
Description | Summary | Not applicable | Not applicable |
Detailed Description | Notes | Not applicable | Not applicable |
Change Request Status | Change_Request_Status | Not applicable | Not applicable |
Status Reason | Status_Reason | Not applicable | Not applicable |
Impact | Impact | Not applicable | Not applicable |
Urgency | Urgency | Not applicable | Not applicable |
Priority | Priority | Not applicable | Not applicable |
Risk Level | Risk_Level | Not applicable | Not applicable |
Class | Class | Not applicable | Not applicable |
Timing_Reason | Timing_Reason | Not applicable | Not applicable |
Lead Time | Lead_Time | Not applicable | Not applicable |
Reason For Change | Reason_For_Change | Not applicable | Not applicable |
Business Justification | Business_Justification | Not applicable | Not applicable |
Environment | Environment | Not applicable | Not applicable |
Performance Rating | Performance_Rating | Not applicable | Not applicable |
Company | Company | Not applicable | Not applicable |
First_Name | First_Name | Not applicable | Not applicable |
Last_Name | Last_Name | Not applicable | Not applicable |
Phone_Number | Phone_Number | Not applicable | Not applicable |
Organization | Organization | Not applicable | Not applicable |
Department | Department | Not applicable | Not applicable |
Support Organization2 | Req_By_Support_ Organization | Not applicable | Not applicable |
Support Group Name2 | Req_By_Support_Group | Not applicable | Not applicable |
Location Company | Location_Company | Not applicable | Not applicable |
Region | Region | Not applicable | Not applicable |
Site Group | Site_Group | Not applicable | Not applicable |
Site | Site | Not applicable | Not applicable |
Chg Location Address | Chg_Location_Address | Not applicable | Not applicable |
Product Cat Tier 1(2) | Product_Cat_Tier_1 | Not applicable | Not applicable |
Product Cat Tier 2(2) | Product_Cat_Tier_2 | Not applicable | Not applicable |
Product Cat Tier 3(2) | Product_Cat_Tier_3 | Not applicable | Not applicable |
Product Model/Version(2) | Product_Model_Version | Not applicable | Not applicable |
Product Name(2) | Product_Name | Not applicable | Not applicable |
Manufacturer(2) | Manufacturer | Not applicable | Not applicable |
Categorization Tier 1 | Categorization_Tier_1 | Not applicable | Not applicable |
Categorization Tier 2 | Categorization_Tier_2 | Not applicable | Not applicable |
Categorization Tier 3 | Categorization_Tier_3 | Not applicable | Not applicable |
Company3 | Chg_Manager_Support_ Company | Not applicable | Not applicable |
Support Organization | Chg_Manager_Support_ Organization | Not applicable | Not applicable |
Support Group Name | Chg_Manager_Support_ Group | Not applicable | Not applicable |
CAB Manager (Change Co-ord) | Change_Manager | Not applicable | Not applicable |
ASCPY | Chg_Assignee_Support_ Company | Not applicable | Not applicable |
ASORG | Chg_Assignee_Support_ Organization | Not applicable | Not applicable |
ASGRP | Chg_Assignee_Support_ Organization | Not applicable | Not applicable |
ASCHG | Change_Coordinator | Not applicable | Not applicable |
ChgImpCpy | Chg_Implementer_ Support_Company | Not applicable | Not applicable |
ChgImpOrg | Chg_Implementer_ Support_Organization | Not applicable | Not applicable |
ChgImpGrp | Chg_Implementer_ Support_Group | Not applicable | Not applicable |
ChgImp | Change_Implementer | Not applicable | Not applicable |
Approval Phase Name | Approval_Phase_Name | Not applicable | Not applicable |
Earliest Start Date | Earliest_Start_Date | Not applicable | Not applicable |
Requested Start Date | Requested_Start_Date | Not applicable | Not applicable |
Requested End Date | Requested_End_Date | Not applicable | Not applicable |
Scheduled Start Date | Scheduled_Start_Date | Not applicable | Not applicable |
Scheduled End Date | Scheduled_End_Date | Not applicable | Not applicable |
Actual Start Date | Actual_Start_Date | Not applicable | Not applicable |
Actual End Date | Actual_End_Date | Not applicable | Not applicable |
In Production | In_Production | Not applicable | Not applicable |
z1D_WorklogDetails | Work_Info_Summary | Not applicable | Required for creating work information. |
z1D_Details | Work_Info_Details | Not applicable | Optional for creating work information. |
z1D_Activity Type | Work_Info_Type | Not applicable | Optional for creating work information. The default value is General Information. If left null. |
z1D_ActivityDate_tab | Work_Info_Date | Not applicable | Optional for creating work information. |
z1D_Communication Source | Work_Info_Source | Not applicable | Optional for creating work information. |
z1D_Secure_Log | Work_Info_Locked | Not applicable | Optional for creating work information. The default value is No. If left null. |
z1D_View_Access | Work_Info_View_Access | Not applicable | Optional for creating work information. The default value is Internal. If left null. |
Change Target Date | Change_Target_Date | Not applicable | Used for tracking the approximate target date for completion of a change request. |
Change_Query_Service and Change_QueryList_Service functions
The Change_Query_Service and Change_QueryList_Service functions are specific to web services. To perform a search outside of web services, use the CHG:Infrastructure Change form.
The following table lists the input field values:
Web service field | Field value | Notes |
|---|---|---|
Infrastructure_Change_ID | Not applicable | Used only by the Change_Query_ Service operation. |
Qualification | Valid AR System qualification | Used only by the Change_QueryList_Service and Change_GetWorkInfoList operation. |
Change Target Date | Change_Target_Date | Used for tracking the approximate target date for completion of a change request. |
The following table lists the output values:
Web service field | Notes |
|---|---|
Infrastructure_Change_ID | Returned only by the Change_QueryList_Service operation. |
Summary | Not applicable |
Notes | Not applicable |
Change_Type | Not applicable |
Change_Request_Status | Not applicable |
Status_Reason | Not applicable |
Risk_Level | Not applicable |
Impact | Not applicable |
Urgency | Not applicable |
Priority | Not applicable |
Company | Not applicable |
First_Name | Not applicable |
Last_Name | Not applicable |
Phone_Number | Not applicable |
Organization | Not applicable |
Department | Not applicable |
Req_By_Support_Organization | Not applicable |
Req_By_Support_Group_Name | Not applicable |
Customer_First_Name | Not applicable |
Customer_Middle_Name | Not applicable |
Customer_Last_Name | Not applicable |
Customer_Phone_Number | Not applicable |
Customer_Organization | Not applicable |
Customer_Department | Not applicable |
Location_Company | Not applicable |
Region | Not applicable |
Site_Group | Not applicable |
Site | Not applicable |
Chg_Location_Address | Not applicable |
Class | Not applicable |
Timing_Reason | Not applicable |
Lead_Time | Not applicable |
Reason_For_Change | Not applicable |
Business_Justification | Not applicable |
Environment | Not applicable |
Performance_Rating | Not applicable |
Product_Cat_Tier_1 | Not applicable |
Product_Cat_Tier_2 | Not applicable |
Product_Cat_Tier_3 | Not applicable |
Product_Name | Not applicable |
Product_Model_Version | Not applicable |
Manufacturer | Not applicable |
Categorization_Tier_1 | Not applicable |
Categorization_Tier_2 | Not applicable |
Categorization_Tier_3 | Not applicable |
Chg_Manager_Support_Company | Not applicable |
Chg_Manager_Support_Organization | Not applicable |
Chg_Manager_Support_Group | Not applicable |
Change_Manager | Not applicable |
Chg_Assignee_Support_Company | Not applicable |
Chg_Assignee_Support_Organization | Not applicable |
Chg_Assignee_Support_Group | Not applicable |
Change_Coordinator | Not applicable |
Chg_Implementer_Support_ Company | Not applicable |
Chg_Implementer_Support_ Organization | Not applicable |
Chg_Implementer_Support_Group | Not applicable |
Change_Implementer | Not applicable |
Approval_Phase_Name | Not applicable |
Earliest_Start_Date | Not applicable |
Requested_Start_Date | Not applicable |
Requested_End_Date | Not applicable |
Scheduled_Start_Date | Not applicable |
Scheduled_End_Date | Not applicable |
Actual_Start_Date | Not applicable |
Actual_End_Date | Not applicable |
In_Production | Not applicable |
BudgetEstimatedTotalTime | Not applicable |
Completed_Date | Not applicable |
Deployment_End_Date | Not applicable |
Deployment_Start_Date | Not applicable |
Submit_Date | Not applicable |
Target_Date | Not applicable |
Change_GetWorkInfoList function
The Change_GetWorkInfoList function retrieves a list of work info records for a list of changes.
The following table lists the input field values:
Web service field | Field value | Notes |
|---|---|---|
Change_Number | Not applicable | This field is used only by the Infrastructure Change ID field. |
Qualification | AR System qualification | Specify the criteria if you want to restrict the search result. |
The following table lists the output values:
Web service field | Notes |
|---|---|
InfrastructureChangeID | Change 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 |
GetListOfRelatedChanges function
The GetListOfRelatedChanges function retrieves a list of related changes.
The following table lists the input field values:
Web service field | Field value | Notes |
|---|---|---|
Change_Number | Not applicable | This field is used only by the Infrastructure Change ID field. |
Qualification | AR System qualification | Specify the criteria if you want to restrict the search result. |
The following table lists the output values in addition to the output values described in Output values:
Web service field | Notes |
|---|---|
Association_Type01 | The relationship type from the change to its related record. |
Request_ID01 | The ID of the record related to the change. |
Request_Type01 | The type of ticket related to the change. |
Comments
Log in or register to comment.